Get data dictionary — get

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(...)

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.

Value

Data frame with the data dictionary.

Examples

get_dd("abcd")
#> Error in check_pkgs(pkgs = list(NBDCtoolsData = list(remote = "nbdc-datahub/NBDCtoolsData")),     abort_msg = "NBDCtoolsData package is not installed", quiet = quiet): NBDCtoolsData package is not installed
#> ✖ `NBDCtoolsData`
#> ℹ Please install the missing packages with:
#> 
#> renv::install(c("nbdc-datahub/NBDCtoolsData"))

get_dd("hbcd", release = "1.0")
#> Error in check_pkgs(pkgs = list(NBDCtoolsData = list(remote = "nbdc-datahub/NBDCtoolsData")),     abort_msg = "NBDCtoolsData package is not installed", quiet = quiet): NBDCtoolsData package is not installed
#> ✖ `NBDCtoolsData`
#> ℹ Please install the missing packages with:
#> 
#> renv::install(c("nbdc-datahub/NBDCtoolsData"))

get_dd("abcd", vars = c("ab_g_dyn__visit_dtt", "ab_g_dyn__visit_age"))
#> Error in check_pkgs(pkgs = list(NBDCtoolsData = list(remote = "nbdc-datahub/NBDCtoolsData")),     abort_msg = "NBDCtoolsData package is not installed", quiet = quiet): NBDCtoolsData package is not installed
#> ✖ `NBDCtoolsData`
#> ℹ Please install the missing packages with:
#> 
#> renv::install(c("nbdc-datahub/NBDCtoolsData"))

get_dd("abcd", tables = "ab_g_dyn")
#> Error in check_pkgs(pkgs = list(NBDCtoolsData = list(remote = "nbdc-datahub/NBDCtoolsData")),     abort_msg = "NBDCtoolsData package is not installed", quiet = quiet): NBDCtoolsData package is not installed
#> ✖ `NBDCtoolsData`
#> ℹ Please install the missing packages with:
#> 
#> renv::install(c("nbdc-datahub/NBDCtoolsData"))

get_dd_abcd()
#> Error in check_pkgs(pkgs = list(NBDCtoolsData = list(remote = "nbdc-datahub/NBDCtoolsData")),     abort_msg = "NBDCtoolsData package is not installed", quiet = quiet): NBDCtoolsData package is not installed
#> ✖ `NBDCtoolsData`
#> ℹ Please install the missing packages with:
#> 
#> renv::install(c("nbdc-datahub/NBDCtoolsData"))

get_dd_hbcd(release = "1.0")
#> Error in check_pkgs(pkgs = list(NBDCtoolsData = list(remote = "nbdc-datahub/NBDCtoolsData")),     abort_msg = "NBDCtoolsData package is not installed", quiet = quiet): NBDCtoolsData package is not installed
#> ✖ `NBDCtoolsData`
#> ℹ Please install the missing packages with:
#> 
#> renv::install(c("nbdc-datahub/NBDCtoolsData"))