_pkgdown.yml

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

template:
  math-rendering: mathjax
  bootstrap: 5
  light-switch: true
  bslib:
    preset: "flatly"
    primary: "#2c3e50"
    navbar-bg: "#2c3e50"
  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/admiraldev/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-example-questions="Tell me a little about the {admiraldev} package., What assertion checks are provided by {admiraldev}?"
      data-modal-search-placeholder="Ask me a question about {admiraldev} or the {admiral} ecosystem..."
      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>
repo:
  url:
    home: https://github.com/pharmaverse/admiraldev
    source: https://github.com/pharmaverse/admiraldev/blob/main/
    issue: https://github.com/pharmaverse/admiraldev/issues/
    user: https://github.com/
news:
  cran_dates: true

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

development:
  mode: auto

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."
  footer:
    roles: [aut, ctb]
    text: "Developed by F. Hoffmann-La Roche AG, GlaxoSmithKline LLC,"
  sidebar:
    roles: [aut, 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/

reference:
- title: Assertion Functions
  desc: Checks the inputs for user-facing functions and provides error, warnings and other messaging around expectation of inputs.
  contents:
  - has_keyword('assertion')

- title: Get Functions
  desc: Gets information or input from an object
  contents:
  - has_keyword('get')

- title: Is Functions
  desc: Is the object what it says it is
  contents:
  - has_keyword('is')

- title: What Functions
  desc: What type of object is this?
  contents:
  - has_keyword('what')

- title: Warning Functions
  desc: Custom warnings intended for users
  contents:
  - has_keyword('warnings')

- title: Test Helper Functions
  desc: Test Utilities that help with organization and presentation of tests
  contents:
  - has_keyword('test_helper')

- title: Temporary Variables
  desc: Tools for creating and removing temporary variables within a dataset
  contents:
  - has_keyword('tmp_vars')

- title: Quosure Helper Functions
  desc: Helping your quosure needs
  contents:
  - has_keyword('quo')

- title: Quoting Helper Functions
  desc: Helping your quoting needs
  contents:
  - has_keyword('quote')

- title: Utilities used within Derivation Functions
  contents:
  - has_keyword('utils_help')

- title: Documentation Functions
  desc: Functions for generating documentation
  contents:
  - has_keyword('documentation')

- title: Miscellaneous
  desc: Utilities without a theme
  contents:
  - has_keyword('dev_utility')
  - has_keyword('messages')

- 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 `{admiral}`.

    *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:
    reference:
      text: Reference
      href: reference/index.html
    articles:
      text: Developer Guides
      menu:
      - text: Programming Strategy
        href: articles/programming_strategy.html
      - text: Writing Vignettes
        href: articles/writing_vignettes.html
      - text: Writing Custom Examples
        href: articles/writing_custom_examples.html
      - text: Unit Test Guidance
        href: articles/unit_test_guidance.html
      - text: Guidance for git and GitHub Usage
        href: articles/git_usage.html
      - text: Pull Request Review Guidance
        href: articles/pr_review_guidance.html
      - text: R CMD Issues
        href: articles/rcmd_issues.html
      - text: Release Strategy
        href: articles/release_strategy.html
      - text: Test Data Guidance
        href: articles/test_data_guidance.html
      - text: Package Extensions
        href: articles/package_extensions.html
    slack:
      icon: fa-slack
      href: https://pharmaverse.slack.com/
      aria-label: Join the pharmaverse Slack!
    newissue:
      icon: fa-bug
      href: https://github.com/pharmaverse/admiraldev/issues/new/choose
      aria-label: Report an issue