_pkgdown.yml

url: https://epiverse-trace.github.io/epiparameter
template:
  package: epiversetheme
  bslib:
    font_weight_base : 300

development:
  mode: unreleased

reference:
  - title: epiparameter classes

  - subtitle: epidist object
    desc: Class constructor, validator, and methods
    contents:
    - epidist
    - discretise
    - ends_with("\\.epidist")
    - -has_keyword("epidist_distribution_functions")
    - -starts_with("convert_")
    - validate_epidist
    - ends_with("\\.multi_epidist")

  - title: Accessors
    desc: Get data from epi classes
    contents:
    - get_citation
    - get_parameters

  - title: epidist helper functions
    desc: Functions to help construct `<epidist>` objects
    contents:
    - starts_with("create_epidist")

  - title: epidist from {epiparameter} library
    desc: Retrieve `<epidist>` object directly from database
    contents:
    - epidist_db

  - title: Coercion
    desc: Convert data from and to `<epidist>`
    contents:
    - as_epidist
    - as_epidist.data.frame

  - title: Explore epiparameters
    desc: Table of epi parameters
    contents:
    - parameter_tbl

  - title: Distribution functions
    desc: Functions for operating on `<epidist>` distributions
    contents:
    - cdf.epidist

  - title: Parameter extraction
    desc: Extract distribution parameters from summary statistics
    contents:
    - extract_param

  - title: Parameter conversion
    desc: Convert distribution parameter to summary statistics and vice versa
    contents:
    - starts_with("convert_")

  - title: Epi object checking
    desc: Check an object is of a certain type or feature
    contents:
    - starts_with("is_")

  - title: Utility function
    contents:
    - calc_disc_dist_quantile

  - title: Package data
    desc: Data stored in the package
    contents:
    - epireview_core_cols

  - title: Options
    contents:
      - epiparameter_options

articles:
- title: Get started
  navbar: Intro
  contents:
  - epiparameter
  - extract_convert

- title: Parameter library
  navbar: Epiparameter Data
  contents:
  - data_protocol
  - database

- title: Data from other packages
  navbar: Handling data from other packages
  contents:
  - articles/data_from_epireview

- title: Auxiliary
  navbar: Auxiliary
  contents:
  - extract-bias

- title: Developer Documentation
  navbar: Developer Documentation
  contents:
  - design_principles