nhanesTableSummary {nhanesA}

Summarize NHANES table

Description

Summarize a NHANES table

Usage

nhanesTableSummary(nh_table, use = c("data", "codebook", "both"), ...)

Arguments

nh_table

the name of a valid NHANES table

use

character string, whether to create a summary from the data itself or the codebook, which respectively use either the NHANES SAS data files or the HTML documentation files. If use = "both" then both are computed as merged; the src and ... arguments are ignored in this case.

...

additional arguments, usually passed on to either nhanes or nhanesCodebook as appropriate. Alternatively, the src argument can be used to pass on an already available data frame or codebook, but this must be consistent with the use argument.

Details

Returns a per-variable summary of a NHANES table either using the actual data or its corresponding codebook

Value

A data frame with one row per variable, with columns depending on the value of the use argument.

Examples

nhanesTableSummary('DEMO_D', use = "data")
nhanesTableSummary('DEMO_D', use = "codebook")