epipredict/_pkgdown.yml at dev · cmu-delphi/epipredict · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
url: https://cmu-delphi.github.io/epipredict/

development:
  mode: devel

template:
  package: delphidocs

navbar:
  structure:
    left: [intro, workflows, backtesting, reference, articles, news]
    right: [search, github, lightswitch]
  components:
    workflows:
      text: Epiworkflows
      href: articles/custom_epiworkflows.html
    backtesting:
      text: Backtesting
      href: articles/backtesting.html
    articles:
      text: Articles
      menu:
        - text: Using the add/update/remove/adjust functions
          href: articles/update.html
        - text: Using epipredict on non-epidemic panel data
          href: articles/panel-data.html

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

  - subtitle: Forecaster modifications
    desc: Constructors to modify forecaster arguments and utilities to produce `epi_workflow` objects
    contents:
      - contains("args_list")
      - contains("_epi_workflow")
  ##########################
  - title: Steps and Layers

  - subtitle: Epi recipe preprocessing steps
    desc: >
      Note that any `{recipes}`
      [`step`](https://recipes.tidymodels.org/reference/index.html) is also valid
    contents:
      - starts_with("step_")

  - subtitle: Frosting post-processing layers
    contents:
      - starts_with("layer_")

  ##########################
  - title: Epiworkflows
  - subtitle: Basic forecasting workflow functions
    contents:
      - epi_recipe
      - epi_workflow
      - add_epi_recipe
      - fit.epi_workflow

  - subtitle: Forecast post-processing workflow functions
    desc: Create and apply series of post-processing operations
    contents:
      - frosting
      - ends_with("_frosting")
      - tidy.frosting
      - contains("slather")

  - subtitle: Prediction
    desc: Methods for prediction and modifying predictions
    contents:
      - predict.epi_workflow
      - augment.epi_workflow
      - get_test_data
      - forecast.epi_workflow

  - subtitle: Modifying forecasting epiworkflows
    desc: >
      Modify or inspect an existing recipe, workflow, or frosting. See also [the
      article on the topic](../articles/update.html)
    contents:
      - adjust_epi_recipe
      - Add_model
      - add_layer
      - layer-processors
      - update.layer

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

  ##########################
  - title: Parsnip engines
    desc: >
      Prediction methods not available in the [general parsnip
      repository](https://www.tidymodels.org/find/parsnip/)
    contents:
      - quantile_reg
      - smooth_quantile_reg
      - grf_quantiles

  ##########################
  - title: Utilities
    contents:
      - flusight_hub_formatter
      - clean_f_name
      - check_enough_data

  - subtitle: Utilities for quantile distribution processing
    contents:
      - pivot_quantiles
      - dist_quantiles
      - contains("quantile_pred")
      - extrapolate_quantiles
      - nested_quantiles
      - weighted_interval_score