nhanesDXA: Import Dual Energy X-ray Absorptiometry (DXA) data.

In oslerinhealth/nhanesA: NHANES Data Retrieval

Description

DXA data were acquired from 1999-2006.

Usage

nhanesDXA(year, suppl = FALSE, destfile = NULL)

Arguments

year	The year of the data to import, where 1999<=year<=2006.
suppl	If TRUE then retrieve the supplemental data (default=FALSE).
destfile	The name of a destination file. If NULL then the data are imported into the R environment but no file is created.

Details

Provide destfile in order to write the data to file. If destfile is not provided then the data will be imported into the R environment.

Value

By default the table is returned as a data frame. When downloading to file, the return argument is the integer code from download.file where 0 means success and non-zero indicates failure to download.

Examples

dxa_b <- nhanesDXA(2001)
dxa_c_s <- nhanesDXA(2003, suppl=TRUE)
nhanesDXA(1999, destfile="dxx.xpt")

oslerinhealth/nhanesA documentation built on May 24, 2021, 12:20 a.m.