Skip to contents

Function to return available StreamCat parameters using the StreamCat API.

Usage

sc_get_params(param = NULL)

Arguments

param

List of available parameters in the API for the following options: name, areaofInterest, region, state, county. State and county return a data frame that includes FIPS codes, names and state abbreviations Syntax: param=<value1>,<value2> Values: name|area

Value

A list of all the current StreamCat values for a given parameter

Author

Marc Weber

Examples

params <- sc_get_params(param='variable_info')
#> Rows: 147 Columns: 14
#> ── Column specification ────────────────────────────────────────────────────────
#> Delimiter: ","
#> chr (13): INDICATOR_CATEGORY, METRIC_NAME, AOI, YEAR, WEBTOOL_NAME, METRIC_D...
#> dbl  (1): DSID
#> 
#>  Use `spec()` to retrieve the full column specification for this data.
#>  Specify the column types or set `show_col_types = FALSE` to quiet this message.
params <- sc_get_params(param='metric_names')
params <- sc_get_params(param='areaOfInterest')
params <- sc_get_params(param='state')
params <- sc_get_params(param='county')