_pkgdown.yml

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

template:
  bootstrap: 5
  params:
    bootswatch: flatly
search:
  exclude: ['news/index.html']
repo:
  url:
    home: https://github.com/pharmaverse/admiral/
    source: https://github.com/pharmaverse/admiral/blob/main/
    issue: https://github.com/pharmaverse/admiral/issues/
    user: https://github.com/
news:
  cran_dates: true

development:
  mode: auto
  # Set version_label to "danger" (= red color) for development/auto mode
  # Else ensure to switch version_label to "default" (= light gray color) before to proceed with an official release
  # version_label: danger
  version_label: default

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/admiral/)."
  footer:
    roles: [aut, ctb, cre, fnd]
    text: "Developed by"
  sidebar:
    roles: [aut]

reference:
- title: Derivations for Adding Variables
- subtitle: All ADaMs
  contents:
  - has_keyword("der_gen")

- subtitle: ADSL-specific
  desc: Derivation functions helpful for building the ADSL dataset
  contents:
  - has_keyword("der_adsl")

- subtitle: BDS-specific
  desc: Derivation functions helpful for building the BDS datasets (e.g. advs, adlb, adeg, adex)
  contents:
  - has_keyword("der_bds_findings")

- subtitle: OCCDS-specific
  desc: Derivation functions helpful for building the OCCDS datasets (e.g. adae, adcm, admh)
  contents:
  - has_keyword("der_occds")

- title: Derivations for Adding Parameters/Records
- subtitle: BDS-specific
  contents:
  - has_keyword("der_prm_bds_findings")

- subtitle: TTE-specific
  contents:
  - has_keyword("der_prm_tte")

- title: Metadata
  desc: Auxiliary datasets providing definitions as input for derivations, e.g. grading criteria or dose frequencies
  contents:
  - has_keyword("metadata")

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

- title: Advanced Functions
- subtitle: Admiral Options
  contents:
  - has_keyword("admiral_options")

- subtitle: Higher Order
  contents:
  - has_keyword("high_order_function")

- subtitle: Creating Auxiliary Datasets
  contents:
  - has_keyword("create_aux")

- subtitle: Source Objects
  contents:
  - has_keyword("source_specifications")

- subtitle: Other
  contents:
  - has_keyword("other_advanced")

- title: Computation Functions for Vectors
- subtitle: All ADaMs
  contents:
  - has_keyword('com_date_time')

- subtitle: BDS-specific
  contents:
  - has_keyword('com_bds_findings')

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

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

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

- subtitle: Utilities for Filtering Observations
  contents:
  - has_keyword('utils_fil')

- subtitle: Utilities for Quosures
  contents:
  - has_keyword('utils_quo')

- subtitle: Utilities used for Examples and Template Scripts
  contents:
  - has_keyword('utils_examples')

- title: Objects exported from other packages
  desc: |
    To maximize the user-friendliness of `{admiral}`, functions from other packages are provided
    without changes made to them, follow the links below to see their documentation.
  contents:
  - has_keyword('reexport')

- title: Superseded
  desc: |
    Superseded functions have been replaced with better functions. However, we
    will not be removing these functions from `{admiral}`.  We do strongly
    encourage you to make the switch over.
  contents:
  - has_keyword("superseded")

navbar:
  structure:
    left: [getstarted, reference, articles, news, versions]
    right: [search, slack, history, newissue, github]
  components:
    getstarted:
      text: Get Started
      menu:
      - text: Get Started
        href: articles/admiral.html
      - text: CDISC Variables mapped to admiral functions
        href: https://pharmaverse.github.io/admiraldiscovery/articles/reactable.html
      - text: Cheatsheet
        href: https://github.com/pharmaverse/admiral/blob/main/inst/cheatsheet/admiral_cheatsheet.pdf
    reference:
      text: Reference
      href: reference/
    articles:
      text: User Guides
      menu:
      - text: "General Guides"
      - text: Programming Concepts and Conventions
        href: articles/concepts_conventions.html
      - text: Generic Derivations
        href: articles/generic.html
      - text: Higher Order Functions
        href: articles/higher_order.html
      - text: -------
      - text: "ADaM Script Guides"
      - text: Creating a Basic ADSL
        href: articles/adsl.html
      - text: Creating an OCCDS ADaM
        href: articles/occds.html
      - text: Creating a BDS Findings ADAM
        href: articles/bds_finding.html
      - text: Creating a BDS Exposure ADaM
        href: articles/bds_exposure.html
      - text: Creating a BDS Time-to-Event ADaM
        href: articles/bds_tte.html
      - text: Creating Questionnaire ADaMs
        href: articles/questionnaires.html
      - text: Creating a PK NCA or Population PK ADaM
        href: articles/pk_adnca.html
      - text: Hy's Law Implementation
        href: articles/hys_law.html
      - text: -------
      - text: "Special Topics Guides"
      - text: Date and Time Imputation
        href: articles/imputation.html
      - text: Visit and Period Variables
        href: articles/visits_periods.html
      - text: Queries Dataset Documentation
        href: articles/queries_dataset.html
      - text: Lab Grading
        href: articles/lab_grading.html
      - text: -------
      - text: FAQ
        href: articles/faq.html

    history:
      icon: fa-history
      href: articles/website-versions.html
      aria-label: Previous Release Websites
    slack:
      icon: fa-slack
      href: https://pharmaverse.slack.com/
      aria-label: Slack
    newissue:
      icon: fa-bug
      href: https://github.com/pharmaverse/admiral/issues/new/choose
      aria-label: New Issue