NBDCtools (version 1.0.2)

get_dd: Get data dictionary

Description

Retrieves data dictionary for a given study and release version. Allows for filtering by variables and tables. Wrapper around get_metadata().

In addition to the main get_dd() function, there are two study-specific variations:

• get_dd_abcd(): for the ABCD study.

• get_dd_hbcd(): for the HBCD study.

They have the same arguments as the get_dd() function, except that the study argument is set to the respective study by default, and should not be set by the user.

Usage

get_dd(study, release = "latest", vars = NULL, tables = NULL)
get_dd_abcd(...)
get_dd_hbcd(...)

Value

Data frame with the data dictionary.

Arguments

study

character. The study name. One of "abcd" or "hbcd".

release

character. Release version (Default: "latest").

vars

character (vector). Vector with the names of variables to be included.

tables

character (vector). Vector with the names of tables to be included.

...

Additional arguments passed to the underlying get_dd() function.

Examples

if (FALSE) { # requireNamespace("NBDCtoolsData", quietly = TRUE)

get_dd("abcd")

get_dd("hbcd", release = "1.0")

get_dd("abcd", vars = c("ab_g_dyn__visit_dtt", "ab_g_dyn__visit_age"))

get_dd("abcd", tables = "ab_g_dyn")

get_dd_abcd()

get_dd_hbcd(release = "1.0")
}