list_stratification_values: DEPRECATED - List stratification values

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

DEPRECATED - List stratification values

Description

Replaced by new more powerful function, list_StratificationTypes().

Usage

list_stratification_values(
  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 values for geographically smoothed versions of a measure (1) or not (0). The default value is 0 because smoothing is not available for most measures.

Value

This function returns a list with each element containing a data frame corresponding to all combinations of specified measures and geographic types. Within each row of the data frame is a nested data frame containing the stratification values. If the specified measure and associated geography type do not have any "Advanced Options" stratifications, the returned list element will be empty.

Examples

## Not run: 



 list_stratification_values(measure=370,format="ID")
 
 
 list_stratification_values(measure=c(370,423,707),format="ID")
 list_stratification_values(measure=c("Number of summertime (May-Sep) heat-related deaths, by year",
  "Number of extreme heat days","Number of months of mild drought or worse per year"),
   format="name")
   
   
   list_stratification_values(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.