Skip to content

Commit ae0f815

Browse files
committed
docs: include list of required variables in design doc.
Closes #52
1 parent 52799c6 commit ae0f815

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

vignettes/design.Rmd

+16-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ knitr::opts_chunk$set(
1414
collapse = TRUE,
1515
comment = "#>"
1616
)
17+
library(dplyr)
1718
```
1819

1920
## Principles
@@ -29,8 +30,9 @@ These are the guiding principles for this package:
2930
is a data frame, the output is a data frame).
3031
4. Functions have consistent naming based on their action.
3132
5. Functions have limited additional arguments.
32-
6. Casing of input variables (upper or lower case) is agnostic, all
33-
internal variables are lower case, and output variables are lower case.
33+
6. Casing of input variables (upper or lower case) is agnostic, all
34+
internal variables are lower case, and output variables are lower
35+
case.
3436

3537
## Use cases
3638

@@ -150,5 +152,16 @@ The exclusion criteria are:
150152
- No insulin drug purchases in the last 10 years prior to the index
151153
date.
152154

153-
## References
155+
## Data required from registers
156+
157+
The following is a list of the variables required from specific
158+
registers in order for the package to classify diabetes status:
154159

160+
```{r, echo=FALSE}
161+
variable_description |>
162+
mutate(Register = paste0(register_name, "(", register_abbrev, ")")) |>
163+
select(Register, Variable = variable_name) |>
164+
knitr::kable()
165+
```
166+
167+
## References

0 commit comments

Comments
 (0)