list_stratification_levels: DEPRECATED -List stratification levels

In CDCgov/EPHTrackR: R interface to the CDC National Public Health Tracking Network

DEPRECATED -List stratification levels

Description

Replaced by new more powerful function, list_StratificationLevels().

Usage

list_stratification_levels(
  measure = NA,
  geo_type = NA,
  geo_type_ID = NA,
  format = "ID",
  smoothing = 0
)

Arguments

measure	Specifies the measure of interest as an ID, name, or shortName. IDs should be unquoted; name and shortName entries should be quoted strings.
geo_type	An optional argument in which you can specify a geographic type as a quoted string (e.g., "State", "County"). The "geographicType" column in the list_geography_types() output contains a list of geo_types associated with each measure.
geo_type_ID	An optional argument in which you can specify a geographic type ID as an unquoted numeric value (e.g., 1, 2). The "geographicTypeId" column in the list_geography_types() output contains a list of geo_types associated with each measure.
format	Indicates whether the measure argument contains entries formatted as an ID, name, or shortName as a quoted string (e.g., "name", "shortName"). The default is ID.
smoothing	Specifies whether to return stratification levels for geographically smoothed versions of a measure (1) or not (0). The default value is 0 because smoothing is not available for most measures. Requesting smoothed data when it is not available will produce an error.

Value

The output of this function is a list with a separate element for each geography type available for the specified measure (e.g., state, county). Each row in the data frames contained as elements in the list shows a stratification available for the measure.

Examples

## Not run: 

list_stratification_levels(measure=370,format="ID")

list_stratification_levels(measure=c(370,423,707),format="ID")

list_stratification_levels(measure=c("Number of summertime (May-Sep) heat-related deaths, by year",
                                "Number of extreme heat days","Number of months of drought per year"),
                      format="shortName")
                      
                      

## End(Not run)

CDCgov/EPHTrackR documentation built on June 6, 2024, 9:21 a.m.