Skip to contents

Get NHES Survey Code Definitions and Survey Meta-data

Source: R/readNHES.R
getNHES_SurveyInfo.Rd

This function returns a data.frame object that defines NHES Survey Codes and survey parameters that are compatible with the readNHES function for use. The resulting data.frame object is useful for user reference or other advanced techniques.

Usage

getNHES_SurveyInfo()

Note

Any changes or modifications to the data.frame object will not change the behavior of readNHES. This function should be treated only as a read-only source of information.

See also

readNHES, viewNHES_SurveyCodes

Author

Tom Fink

Examples

if (FALSE) { # \dontrun{
  #retrieves the NHES survey meta-data to a data.frame
  surveyInfo <- getNHES_SurveyInfo()
  
  #View the survey data where the year is equal to 2016 in RStudio
  View(subset(surveyInfo, surveyInfo$Year==2016))
} # }