_pkgdown.yml

# Add URL for website metadata
# src: https://pkgdown.r-lib.org/articles/metadata.html
url: https://clavellab.github.io/maldipickr

home:
  title: "Reduce the redundancy of bacterial isolates"
  description: "A R package to dereplicate and cherry-pick mass spectrometry spectra obtained from bacterial isolates."


# Analytics according to https://pkgdown.r-lib.org/reference/build_site.html#analytics
template:
  bootswatch: litera
  bootstrap: 5
  bslib:
    base_font: "Atkinson Hyperlegible"
    code_font: "Hack"
    primary: "#cf5c36"
  theme: "tango"
  opengraph:
    image:
      src: https://repository-images.githubusercontent.com/613291736/be5379b5-ce72-430d-bb4c-70155ba6a0ad
      alt: "maldipickr logo with the legend Dereplicate and cherry-pick mass spectrometry spectra"
  includes:
    in_header: |
        <!-- Matomo -->
        <script>
          var _paq = window._paq = window._paq || [];
          /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
          _paq.push(["setDocumentTitle", document.domain + "/" + document.title]);
          _paq.push(['trackPageView']);
          _paq.push(['enableLinkTracking']);
          (function() {
            var u="https://piwik.cebitec.uni-bielefeld.de/";
            _paq.push(['setTrackerUrl', u+'matomo.php']);
            _paq.push(['setSiteId', '24']);
            var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
            g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
          })();
        </script>
        <!-- End Matomo Code -->


reference:
  - title: "Import"
    desc: "Functions to import raw spectra, identifications or clusters"
    contents:
      - starts_with("import_")
      - starts_with("read_")

  - title: "Process"
    desc: "Functions to analyze and verify multiple spectra data"
    contents:
      - check_spectra
      - merge_processed_spectra
      - process_spectra
      - remove_spectra

  - title: "Dereplicate"
    desc: "Functions to cluster and reduce redundancy"
    contents:
      - starts_with("delineate_")

  - title: "Cherry-pick"
    desc: "Function to pinpoint and label specific spectra within clusters"
    contents:
      - pick_spectra
      - set_reference_spectra

  - title: "Miscellaneous"
    contents:
      - is_well_on_edge
      - gather_spectra_stats
      - get_spectra_names

news:
  releases:
  - text: "Version 1.3.2"
    href: "https://clavellab.github.io/maldipickr/news/index.html#maldipickr-132"
  - text: "Version 1.3.1"
    href: "https://clavellab.github.io/maldipickr/news/index.html#maldipickr-131"
  - text: "Version 1.3.0"
    href: "https://clavellab.github.io/maldipickr/news/index.html#maldipickr-130"
  - text: "Version 1.2.0"
    href: "https://clavellab.github.io/maldipickr/news/index.html#maldipickr-120"
  - text: "Version 1.1.1"
    href: "https://clavellab.github.io/maldipickr/news/index.html#maldipickr-111"

development:
  mode: release