_pkgdown.yml

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

template:
  bootstrap: 5
  params:
    bootswatch: flatly
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

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, cre, fnd]
    text: "Developed by"
  sidebar:
    roles: [aut]

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: Getting Datasets
  desc: Retrieve a dataset from the `admiraldev_environment` enironment
  contents:
  - has_keyword('datasets')

- 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')

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

- title: Join Functions
  desc: dplyr join function without warning about different attributes
  contents:
  - has_keyword('joins')

- 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:
 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: 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