_pkgdown.yml

url: https://cmu-delphi.github.io/epipredict/

development:
  mode: devel

template:
  package: delphidocs

articles:
  - title: Get started
    navbar: ~
    contents:
      - epipredict
      - preprocessing-and-models
      - backtesting
      - arx-classifier
      - update
  - title: Advanced methods
    contents:
      - articles/smooth-qr
      - panel-data

repo:
  url:
    home: https://github.com/cmu-delphi/epipredict/
    source: https://github.com/cmu-delphi/epipredict/
    issue: https://github.com/cmu-delphi/epipredict/issues

home:
  links:
    - text: The epiprocess package
      href: https://cmu-delphi.github.io/epiprocess/
  sidebar:
    structure: [links, license, community, citation, authors, dev, related]
    components:
      related:
        title: Delphi packages and resources
        text: |
          * [The epidatr package](https://github.com/cmu-delphi/epidatr/)
          * [The epiprocess package](https://cmu-delphi.github.io/epiprocess/)
          * [The epidatasets package](https://cmu-delphi.github.io/epidatasets/)
          * [Introduction to Delphi's Tooling Work](https://cmu-delphi.github.io/delphi-tooling-book/)

reference:
  - title: Simple forecasters
    desc: Complete forecasters that produce reasonable baselines
    contents:
      - contains("forecaster")
      - contains("classifier")

  - title: Forecaster modifications
    desc: Constructors to modify forecaster arguments and utilities to produce `epi_workflow` objects
    contents:
      - contains("args_list")
      - contains("_epi_workflow")
  - title: Helper functions for Hub submission
    contents:
      - flusight_hub_formatter

  - title: Parsnip engines
    desc: Prediction methods not available elsewhere
    contents:
      - quantile_reg
      - smooth_quantile_reg
      - grf_quantiles

  - title: Custom panel data forecasting workflows
    contents:
      - epi_recipe
      - epi_workflow
      - add_epi_recipe
      - adjust_epi_recipe
      - Add_model
      - predict.epi_workflow
      - fit.epi_workflow
      - augment.epi_workflow
      - forecast.epi_workflow

  - title: Epi recipe preprocessing steps
    contents:
      - starts_with("step_")
      - contains("bake")

  - title: Epi recipe verification checks
    contents:
      - check_enough_train_data

  - title: Forecast postprocessing
    desc: Create a series of postprocessing operations
    contents:
      - frosting
      - ends_with("_frosting")
      - get_test_data
      - tidy.frosting

  - title: Frosting layers
    contents:
      - contains("layer")
      - contains("slather")

  - title: Automatic forecast visualization
    contents:
      - autoplot.epi_workflow
      - autoplot.canned_epipred

  - title: Utilities for quantile distribution processing
    contents:
      - dist_quantiles
      - extrapolate_quantiles
      - nested_quantiles
      - weighted_interval_score
      - starts_with("pivot_quantiles")

  - title: Other utilities
    contents:
      - clean_f_name