nhanesA (version 0.6.5.3)

nhanesSearchTableNames: Search for matching table names

Description

Returns a list of table names that match a specified pattern.

Usage

nhanesSearchTableNames(
  pattern = NULL,
  ystart = NULL,
  ystop = NULL,
  includerdc = FALSE,
  nchar = 100,
  details = FALSE
)

Arguments

pattern

Pattern of table names to match

ystart

Four digit year of first survey included in search, where ystart >= 1999.

ystop

Four digit year of final survey included in search, where ystop >= ystart.

includerdc

If TRUE then RDC only tables are included (default=FALSE).

nchar

Truncates the variable description to a max length of nchar.

details

If TRUE then complete table information from the comprehensive data list is returned (default=FALSE).

Value

A list of table names that match the pattern.

Details

Searches the Doc File field in the NHANES Comprehensive Data List (see https://wwwn.cdc.gov/nchs/nhanes/search/DataPage.aspx) for tables that match a given name pattern. Only a single pattern may be entered.

Examples

# NOT RUN {
nhanesSearchTableNames('BMX')
# }
# NOT RUN {
nhanesSearchTableNames('HPVS', includerdc=TRUE, details=TRUE)
# }