Skip to content

Commit 28063be

Browse files
committed
reorganize reference page
1 parent 5003736 commit 28063be

File tree

1 file changed

+49
-35
lines changed

1 file changed

+49
-35
lines changed

_pkgdown.yml

Lines changed: 49 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ template:
99

1010
navbar:
1111
structure:
12-
left: [intro, workflows, backtesting, reference, articles, news]
12+
left: [intro, workflows, backtesting, reference, articles, news]
1313
right: [search, github, lightswitch]
1414
components:
1515
workflows:
@@ -48,71 +48,85 @@ reference:
4848
- contains("forecaster")
4949
- contains("classifier")
5050

51-
- title: Forecaster modifications
51+
- subtitle: Forecaster modifications
5252
desc: Constructors to modify forecaster arguments and utilities to produce `epi_workflow` objects
5353
contents:
5454
- contains("args_list")
5555
- contains("_epi_workflow")
56+
##########################
57+
- title: Steps and Layers
5658

57-
- title: Helper functions for Hub submission
59+
- subtitle: Epi recipe preprocessing steps
60+
desc: >
61+
Note that any `{recipes}`
62+
[`step`](https://recipes.tidymodels.org/reference/index.html) is also valid
5863
contents:
59-
- flusight_hub_formatter
64+
- starts_with("step_")
6065

61-
- title: Parsnip engines
62-
desc: Prediction methods not available elsewhere
66+
- subtitle: Frosting post-processing layers
6367
contents:
64-
- quantile_reg
65-
- smooth_quantile_reg
66-
- grf_quantiles
68+
- starts_with("layer_")
6769

68-
- title: Custom panel data forecasting workflows
70+
##########################
71+
- title: Epiworkflows
72+
- subtitle: Basic forecasting workflow functions
6973
contents:
7074
- epi_recipe
7175
- epi_workflow
7276
- add_epi_recipe
73-
- adjust_epi_recipe
74-
- Add_model
75-
- predict.epi_workflow
7677
- fit.epi_workflow
77-
- augment.epi_workflow
78-
- forecast.epi_workflow
79-
80-
- title: Epi recipe preprocessing steps
81-
contents:
82-
- starts_with("step_")
83-
- contains("bake")
8478

85-
- title: Epi recipe verification checks
86-
contents:
87-
- check_enough_data
88-
89-
- title: Forecast postprocessing
90-
desc: Create a series of postprocessing operations
79+
- subtitle: Forecast post-processing workflow functions
80+
desc: Create and apply series of post-processing operations
9181
contents:
9282
- frosting
9383
- ends_with("_frosting")
94-
- get_test_data
9584
- tidy.frosting
85+
- contains("slather")
9686

97-
- title: Frosting layers
87+
- subtitle: Prediction
88+
desc: Methods for prediction and modifying predictions
9889
contents:
99-
- contains("layer")
100-
- contains("slather")
90+
- predict.epi_workflow
91+
- augment.epi_workflow
92+
- get_test_data
93+
- forecast.epi_workflow
10194

95+
- subtitle: Modifying forecasting epiworkflows
96+
desc: modify or inspect an existing recipe, workflow, or frosting
97+
contents:
98+
- adjust_epi_recipe
99+
- Add_model
100+
- add_layer
101+
- layer-processors
102+
- update.layer
103+
104+
##########################
102105
- title: Automatic forecast visualization
103106
contents:
104107
- autoplot.epi_workflow
105108
- autoplot.canned_epipred
106109

107-
- title: Utilities for quantile distribution processing
110+
##########################
111+
- title: Parsnip engines
112+
desc: Prediction methods not available elsewhere
113+
contents:
114+
- quantile_reg
115+
- smooth_quantile_reg
116+
- grf_quantiles
117+
118+
##########################
119+
- title: Utilities
120+
contents:
121+
- flusight_hub_formatter
122+
- clean_f_name
123+
- check_enough_data
124+
125+
- subtitle: Utilities for quantile distribution processing
108126
contents:
109127
- dist_quantiles
110128
- contains("quantile_pred")
111129
- extrapolate_quantiles
112130
- nested_quantiles
113131
- weighted_interval_score
114132
- starts_with("pivot_quantiles")
115-
116-
- title: Other utilities
117-
contents:
118-
- clean_f_name

0 commit comments

Comments
 (0)