nhanesSearchTableNames: Search for matching table names

Description Usage Arguments Details Value Examples

View source: R/nhanes.R

Description

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

Usage

1
2
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).

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.

Value

A list of table names that match the pattern.

Examples

1
2
nhanesSearchTableNames('BMX')
nhanesSearchTableNames('HPVS', includerdc=TRUE, details=TRUE)

nhanesA documentation built on May 30, 2017, 7:22 a.m.