View source: R/nhanes_translate.R
nhanesTranslate | R Documentation |
Returns code translations for categorical variables, which appear in most NHANES tables.
nhanesTranslate(
nh_table,
colnames = NULL,
data = NULL,
nchar = 32,
mincategories = 2,
details = FALSE,
dxa = FALSE
)
nh_table |
The name of the NHANES table to retrieve. |
colnames |
The names of the columns to translate. |
data |
If a data frame is passed, then code translation will be applied directly to the data frame. |
nchar |
Applies only when data is defined. Code translations can be very long. |
mincategories |
The minimum number of categories needed for code translations to be applied to the data (default=2). |
details |
If TRUE then all available table translation information is displayed (default=FALSE). |
dxa |
If TRUE then the 2005-2006 DXA translation table will be used (default=FALSE). |
Most NHANES data tables have encoded values. E.g. 1 = 'Male', 2 = 'Female'. Thus it is often helpful to view the code translations and perhaps insert the translated values in a data frame. Only a single table may be specified, but multiple variables within that table can be selected. Code translations are retrieved for each variable.
The code translation table (or translated data frame when data is defined). Returns NULL upon error.
nhanesTranslate('DEMO_B', c('DMDBORN','DMDCITZN'))
nhanesTranslate('BPX_F', 'BPACSZ', details=TRUE)
nhanesTranslate('BPX_F', 'BPACSZ', data=nhanes('BPX_F'))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.