nhanesCodebook: Display codebook for selected variable.
In nhanesA: NHANES Data Retrieval
View source: R/nhanes_codebook.R
nhanesCodebook R Documentation
Display codebook for selected variable.
Description
Returns full NHANES codebook including Variable Name, SAS Label, English Text, Target,
and Value distribution.
Usage
nhanesCodebook(nh_table, colname, dxa = FALSE)
Arguments
nh_table
The name of the NHANES table that contains the desired variable.
colname
The name of the table column (variable).
dxa
If TRUE then the 2005-2006 DXA codebook will be used (default=FALSE).
Details
Each NHANES variable has a codebook that provides a basic description
as well as the distribution or range of values. This function returns the full
codebook information for the selected variable.
Value
The codebook is returned as a list object. Returns NULL upon error.
Examples
nhanesCodebook('AUX_D', 'AUQ020D')
nhanesCodebook('BPX_J', 'BPACSZ')
nhanesA documentation built on July 26, 2023, 5:41 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/nhanes_codebook.R
| nhanesCodebook | R Documentation |
Display codebook for selected variable.
Description
Returns full NHANES codebook including Variable Name, SAS Label, English Text, Target, and Value distribution.
Usage
nhanesCodebook(nh_table, colname, dxa = FALSE)
Arguments
nh_table |
The name of the NHANES table that contains the desired variable. |
colname |
The name of the table column (variable). |
dxa |
If TRUE then the 2005-2006 DXA codebook will be used (default=FALSE). |
Details
Each NHANES variable has a codebook that provides a basic description as well as the distribution or range of values. This function returns the full codebook information for the selected variable.
Value
The codebook is returned as a list object. Returns NULL upon error.
Examples
nhanesCodebook('AUX_D', 'AUQ020D')
nhanesCodebook('BPX_J', 'BPACSZ')
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.