browseNHANES: Open a browser to NHANES.

View source: R/nhanes.R

browseNHANESR Documentation

Open a browser to NHANES.

Description

The browser may be directed to a specific year, survey, or table.

Usage

browseNHANES(
  year = NULL,
  data_group = NULL,
  nh_table = NULL,
  local = TRUE,
  browse = TRUE
)

Arguments

year

The year in yyyy format where 1999 <= yyyy.

data_group

The type of survey (DEMOGRAPHICS, DIETARY, EXAMINATION, LABORATORY, QUESTIONNAIRE). Abbreviated terms may also be used: (DEMO, DIET, EXAM, LAB, Q).

nh_table

The name of an NHANES table.

local

logical flag. If TRUE, and a local or alternative source was specificed using the environment variable NHANES_TABLE_BASE, this will be used in preference to the CDC website at https://wwwn.cdc.gov for named tables.

browse

logical flag, indicating whether the specific NHANES site should be opened using a browser (which is the default behaviour).

Details

By default, browseNHANES will open a web browser to the specified NHANES site.

Value

A character string giving the URL, invisibly if the URL is also opened using browseURL.

Examples

browseNHANES(browse = FALSE)       # Defaults to the main data sets page
browseNHANES(2005)                 # The main page for the specified survey year
browseNHANES(2009, 'EXAM')         # Page for the specified year and survey group
browseNHANES(nh_table = 'VIX_D')   # Page for a specific table
browseNHANES(nh_table = 'DXA')     # DXA main page

nhanesA documentation built on July 4, 2024, 9:08 a.m.