_pkgdown.yml

url: https://pharmaverse.github.io/admiralonco/

template:
  bootstrap: 5
  light-switch: true
  params:
   bootswatch: flatly
  includes:
    css: pkgdown/extra.css
    in_header: |
      <script
      async
      src="https://widget.kapa.ai/kapa-widget.bundle.js"
      data-website-id="2c7249cc-f1dc-4a63-8674-6ecbcb34d95c"
      data-project-name="admiral"
      data-project-color="#2c3e50"
      data-project-logo="https://pharmaverse.github.io/admiralonco/cran-release/logo.png"
      data-consent-required="true"
      data-user-analytics-cookie-enabled="true"
      data-consent-screen-title="Help us improve our AI assistant"
      data-consent-screen-disclaimer="By clicking 'Allow tracking', you consent to anonymous user tracking which helps us improve our service. We don't collect any personally identifiable information."
      data-consent-screen-accept-button-text="Allow tracking"
      data-consent-screen-reject-button-text="No, thanks"
      data-modal-search-placeholder="Ask me a question about {admiralonco} or the {admiral} ecosystem..."
      data-modal-example-questions="Tell me a little about the {admiralonco} package., What are some important {admiralonco} vignettes and what do they describe?"
      data-modal-z-index="9999"
      ></script>

      <script>
      document.addEventListener("DOMContentLoaded", function () {
        // Select all navbar links that have an aria-label
        var navLinks = document.querySelectorAll('.navbar-nav .nav-link[aria-label]');

        navLinks.forEach(function (link) {
          // Initialize Bootstrap 5 Tooltip
          link.setAttribute('title', link.getAttribute('aria-label'));
          new bootstrap.Tooltip(link, {
            placement: 'bottom', // Tooltip appears below the icon
            trigger: 'hover'
          });
        });
      });
      </script>
search:
  exclude: ['news/index.html']
repo:
  url:
    home: https://github.com/pharmaverse/admiralonco
    source: https://github.com/pharmaverse/admiralonco/blob/main/
    issue: https://github.com/pharmaverse/admiralonco/issues/
    user: https://github.com/
news:
    cran_dates: true

home:
  links:
  - text: 🌍 {admiral} ecosystem 🌍
    href: https://pharmaverse.org/e2eclinical/adam/

authors:
  before: "We define *authors* as those who are actively maintaining the code
  base, and *contributors* as those who made a significant contribution in the
  past. For all acknowledgements, see the eponymous section in the
  [Home Page](https://pharmaverse.github.io/admiralonco)."
  footer:
    roles: [aut, ctb, cre]
    text: "Developed by F. Hoffmann-La Roche AG, GlaxoSmithKline LLC, Amgen Inc., Bristol Myers Squibb,"
  sidebar:
    roles: [aut, ctb, fnd]
  F. Hoffmann-La Roche AG:
    html: "<a href='https://www.roche.com/'><img src='man/figures/roche_logo.png' height='34' alt='Roche logo' /></a>"
    href: https://roche.com/
  GlaxoSmithKline LLC:
    html: "<a href='https://www.gsk.com/'><img src='man/figures/gsk_logo.png' height='20' alt='GSK logo' /></a>"
    href: https://gsk.com/
  Amgen Inc.:
    html: "<a href='https://www.amgen.com/'><img src='man/figures/amgen_logo.png' height='20' alt='Amgen logo' /></a>"
    href: https://amgen.com/
  Bristol Myers Squibb:
    html: "<a href='https://www.bms.com/'><img src='man/figures/bms_logo.png' height='20' alt='BMS logo' /></a>"
    href: https://bms.com/

reference:

 - title: Pre-Defined Objects
   desc: 'Objects defined by `{admiralonco}` that can be used as input for derivations'
 - contents:
   - has_keyword("source_specifications")

 - title: Utility Functions
 - subtitle: Utilities for Formatting Observations
 - contents:
   - has_keyword('utils_fmt')

 - subtitle: Utilities for Dataset Checking
 - contents:
   - has_keyword('utils_ds_chk')

 - title: Example Datasets
   desc: You can run `admiral::use_ad_template()` to produce additional datasets
 - contents:
   - has_keyword('datasets')

 - title: Deprecated
   desc: |
     Functions and arguments may need to be removed or replaced over time.
     In such cases, the function or argument will enter a 3 year deprecation cycle.
     The cycle will be tied as close as sensibly possible to a package release.

     When a function is deprecated:

     * In Year 1, there will be a message issued if you use the function/argument, but it will still be available to use.
     * In Year 2, a warning will be produced if you use the function/argument, but it will still be available to use.
     * In Year 3, an error will be produced if you use the function/argument and no longer be able to use.
     * Finally, after 3 years, the function/argument and related documentation and tests will be removed from `{admiralonco}`.

     *Note: Guidance on replacement functionality will be found in the message
     produced as well as in the function's documentation.*

     Below, you can find a list of functions in the process of being deprecated:
   contents:
   - has_keyword("deprecated")

navbar:
  structure:
    left: [getstarted, reference, articles, news]
    right: [search, slack, newissue, github, lightswitch]
  components:
    getstarted:
      text: Get Started
      menu:
      - text: Get Started
        href: articles/admiralonco.html
      - text: Explore ADaM Templates 🧭
        href: articles/templates.html
    reference:
      text: Reference
      href: reference/index.html
    articles:
      text: User Guides
      menu:
      - text: Creating a Basic ADRS
        href: articles/adrs_basic.html
      - text: Creating ADRS (Including Non-standard Endpoints)
        href: articles/adrs.html
      - text: Creating ADRS with iRECIST endpoints
        href: articles/irecist.html
      - text: Creating ADRS with IMWG Criteria
        href: articles/adrs_imwg.html
      - text: Creating ADRS with GCIG Criteria
        href: articles/adrs_gcig.html
      - text: Creating ADRS with PCWG3 Criteria
        href: articles/adrs_pcwg3.html
      - text: Creating ADTTE
        href: articles/adtte.html
      - text: Creating ADTR
        href: articles/adtr.html
      - text: Creating and Using New Anti-Cancer Start Date
        href: articles/nactdt.html
    slack:
      icon: fa-slack
      href: https://app.slack.com/client/T028PB489D3/C02M8KN8269
      aria-label: Join the pharmaverse Slack!
    newissue:
      icon: fa-bug
      href: https://github.com/pharmaverse/admiralonco/issues/new/choose
      aria-label: Report an Issue