-
Notifications
You must be signed in to change notification settings - Fork 0
/
_pkgdown.yml
138 lines (138 loc) · 3.94 KB
/
_pkgdown.yml
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
136
137
138
url: https://yu-group.github.io/simChef
template:
bootstrap: 5
development:
mode: auto
reference:
- title: "Experiment"
desc: >
Functions for creating and running a simulation experiment.
contents:
- Experiment
- create_experiment
- run_experiment
- generate_data
- fit_experiment
- evaluate_experiment
- visualize_experiment
- add_dgp
- update_dgp
- remove_dgp
- get_dgps
- remove_vary_across
- clear_cache
- get_cached_results
- get_save_dir
- set_save_dir
- save_experiment
- export_visualizers
- title: "Simulation Experiment Directory Setup"
desc: >
Functions for automatically setting up a simulation experiment directory.
contents:
- create_sim
- title: "R Markdown Report"
desc: >
Functions for summarizing and visualizing results from a simulation
experiment in a knitted R Markdown report.
contents:
- set_doc_options
- init_docs
- render_docs
- create_rmd
- title: "DGP"
desc: >
Functions for creating a DGP (data-generating process).
contents:
- DGP
- create_dgp
- title: "Method"
desc: >
Functions for creating a Method.
contents:
- Method
- create_method
- title: "Evaluator"
desc: >
Functions for creating an Evaluator.
contents:
- Evaluator
- create_evaluator
- title: "Visualizer"
desc: >
Functions for creating a Visualizer.
contents:
- Visualizer
- create_visualizer
- subtitle: "Evaluator Library: Prediction"
desc: >
A library of common functions for evaluating prediction-focused simulation experiments.
contents:
- eval_pred_err_funs
- eval_pred_curve_funs
- subtitle: "Evaluator Library: Feature Selection"
desc: >
A library of common functions for evaluating feature-selection-focused simulation experiments.
contents:
- eval_feature_selection_err_funs
- eval_feature_selection_curve_funs
- eval_feature_importance_funs
- subtitle: "Evaluator Library: Inference"
desc: >
A library of common functions for evaluating inference-focused simulation experiments.
contents:
- eval_testing_err_funs
- eval_testing_curve_funs
- eval_reject_prob
- subtitle: "Evaluator Library: Additional Yardstick Metrics"
desc: >
A library of additional `yardstick` metrics for evaluating simulation experiments.
contents:
- fp
- tp
- neg
- pos
- subtitle: "Visualizer Library: Prediction"
desc: >
A library of common functions for visualizing prediction-focused simulation experiments.
contents:
- plot_pred_err
- plot_pred_curve
- subtitle: "Visualizer Library: Feature Selection"
desc: >
A library of common functions for visualizing feature-selection-focused simulation experiments.
contents:
- plot_feature_selection_err
- plot_feature_selection_curve
- plot_feature_importance
- subtitle: "Visualizer Library: Inference"
desc: >
A library of common functions for visualizing inference-focused simulation experiments.
contents:
- plot_testing_err
- plot_testing_curve
- plot_reject_prob
- subtitle: "Boilerplate Templates"
desc: >
A library of minimalistic templates for running common types of simulation experiments.
contents:
- library_templates
- subtitle: "Testing Functions"
desc: >
Functions for test-driven simulation studies.
contents:
- run_tests
- test_sim_dir
- subtitle: "Developer Functions"
desc: >
Helper functions for developers to create their own simulation experiment components.
contents:
- eval_constructor
- eval_summarizer
- plot_eval_constructor
- plot_fit_constructor
- get_dot_args
- get_plot_data
- list_col_to_chr
- load_all
- add_na_counts