nhanesAttr: Returns the attributes of an NHANES data table.

In nhanesA: NHANES Data Retrieval

Returns the attributes of an NHANES data table.

Description

Returns attributes such as number of rows, columns, and memory size, but does not return the table itself.

Usage

nhanesAttr(nh_table)

Arguments

nh_table

The name of the specific table to retrieve

Details

nhanesAttr allows one to check the size and other charactersistics of a data table before importing into R. To retrieve these characteristics, the specified table is downloaded, characteristics are determined, then the table is deleted.

Value

The following attributes are returned as a list
nrow = number of rows
ncol = number of columns
names = name of each column
unique = true if all SEQN values are unique
na = number of 'NA' cells in the table
size = total size of table in bytes
types = data types of each column

Examples

nhanesAttr('BPX_E')
nhanesAttr('FOLATE_F')

nhanesA documentation built on July 26, 2023, 5:41 p.m.