forked from pharmaverse/admiral
-
Notifications
You must be signed in to change notification settings - Fork 0
/
_pkgdown.yml
180 lines (152 loc) · 5.14 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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
url: https://pharmaverse.github.io/admiral
template:
bootstrap: 5
params:
bootswatch: flatly
search:
exclude: ['news/index.html']
repo:
url:
home: https://github.com/pharmaverse/admiral/
source: https://github.com/pharmaverse/admiral/blob/main/
issue: https://github.com/pharmaverse/admiral/issues/
user: https://github.com/
news:
cran_dates: true
reference:
- title: Derivations for Adding Variables
- subtitle: All ADaMs
contents:
- has_keyword("der_gen")
- subtitle: ADSL-specific
desc: Derivation functions helpful for building the ADSL dataset
contents:
- has_keyword("der_adsl")
- subtitle: BDS-specific
desc: Derivation functions helpful for building the BDS datasets (e.g. advs, adlb, adeg, adex)
contents:
- has_keyword("der_bds_findings")
- subtitle: OCCDS-specific
desc: Derivation functions helpful for building the OCCDS datasets (e.g. adae, adcm, admh)
contents:
- has_keyword("der_occds")
- title: Derivations for Adding Parameters/Records
- subtitle: BDS-specific
contents:
- has_keyword("der_prm_bds_findings")
- subtitle: TTE-specific
contents:
- has_keyword("der_prm_tte")
- title: Metadata
desc: Auxiliary datasets providing definitions as input for derivations, e.g. grading criteria or dose frequencies
contents:
- has_keyword("metadata")
- title: Advanced Functions
- subtitle: Admiral Options
contents:
- has_keyword("admiral_options")
- subtitle: Higher Order
contents:
- has_keyword("high_order_function")
- subtitle: Creating Auxiliary Datasets
contents:
- has_keyword("create_aux")
- subtitle: Other
contents:
- has_keyword("source_specifications")
- title: Computation Functions for Vectors
- subtitle: All ADaMs
contents:
- has_keyword('com_date_time')
- subtitle: BDS-specific
contents:
- has_keyword('com_bds_findings')
- title: Utility Functions
- subtitle: Utilities for Formatting Observations
contents:
- has_keyword('utils_fmt')
- subtitle: Utilities for Dataset Checking
contents:
- has_keyword('utils_ds_chk')
- subtitle: Utilities used within Derivation Functions
contents:
- has_keyword('utils_help')
- subtitle: Utilities for Filtering Observations
contents:
- has_keyword('utils_fil')
- subtitle: Utilities used for Date Imputation
contents:
- has_keyword('utils_impute')
- subtitle: Utilities for Quosures
contents:
- has_keyword('utils_quo')
- subtitle: Utilities used for Examples and Template Scripts
contents:
- has_keyword('utils_examples')
- subtitle: Utilities for Printing
contents:
- has_keyword('utils_print')
- title: Example Datasets
desc: You can run `use_ad_template()` to produce additional datasets
contents:
- has_keyword('datasets')
- title: Deprecated
desc: |
As `{admiral}` is still evolving, functions/parameters may need to be removed or replaced over time. In such cases, the function/parameter will enter the following 6-month deprecation cycle:
* In the first release (0-3 months), there will be a warning issued if you use the function/parameter, but it will still be available to use.
* In the following release (3-6 months), an error will be produced if you use the function/parameter.
* Finally, from the 3rd release (6 months) onwards, the function/parameter will be removed from `{admiral}` and its documentation completely.
*Note: Guidance on replacement functionality can be found in the warning/error message produced or in the function's documentation.*
Below, you can find a list of functions in the process of being deprecated:
contents:
- has_keyword("deprecated")
navbar:
structure:
left: [getstarted, reference, articles, community, news]
components:
getstarted:
text: Get Started
href: articles/admiral.html
reference:
text: Reference
href: reference/index.html
community:
text: Community
menu:
- text: Contribute to admiral
href: articles/contribution_model.html
- text: Find us on Slack
href: https://app.slack.com/client/T028PB489D3/C02M8KN8269
- text: Welcome to the Pharmaverse
href: https://pharmaverse.org/
articles:
text: User Guides
menu:
- text: Getting Started
- text: Creating a basic ADSL
href: articles/adsl.html
- text: FAQ
href: articles/faq.html
- text: -------
- text: "Deep Dives on ADaMs"
- text: Creating an OCCDS ADaM
href: articles/occds.html
- text: Creating a BDS Findings ADAM
href: articles/bds_finding.html
- text: Creating a BDS Exposure ADaM
href: articles/bds_exposure.html
- text: Creating a BDS Time-to-Event ADaM
href: articles/bds_tte.html
- text: "Advanced User Guides"
- text: Date and Time Imputation
href: articles/imputation.html
- text: Visit and Period Variables
href: articles/visits_periods.html
- text: Generic Functions
href: articles/generic.html
- text: Higher Order Functions
href: articles/higher_order.html
- text: Queries Dataset Documentation
href: articles/queries_dataset.html
- text: Lab Grading
href: articles/lab_grading.html