Function to return StreamCat catchment and watershed metrics using the StreamCat API. The function allows a user to get specific metric data aggregated by area of interest, returned by comid(s), hydroregion(s), state(s), or county(ies).
Usage
sc_get_data(
comid = NULL,
metric = NULL,
aoi = NULL,
showAreaSqKm = NULL,
showPctFull = NULL,
state = NULL,
county = NULL,
region = NULL,
conus = NULL,
countOnly = NULL
)Arguments
- comid
Return metric information for specific COMIDs. Needs to be a character string and function will convert to this format if needed. Syntax: comid=<comid1>,<comid2>
- metric
Name(s) of metrics to query. This is a comma delimited list of metrics or or if metric='all' then all metrics will be queried. Syntax: name=<name1>,<name2>
- aoi
Specify the area of interest described by a metric. For riparian area (catrp100 and wsrp100) if the metric does not have data for the riparian area, no data is returned for that AOI. Certain metrics have no AOI specified for StreamCat so AOI needs to be left null. These metrics are: BankfullDepth, BankfullWidth, CHEM_V2_1, CONN, HABT, HYD, ICI, IWI, TEMP, WettedWidth, prg_bmmi, and all the mast, msst, mwst metrics
Syntax: areaOfInterest=<value1>,<value2> Values: cat|ws|catrp100|wsrp100
- showAreaSqKm
Return the area in square kilometers of a given area of interest. The default value is false. Values: true|false
- showPctFull
Return the pctfull for each dataset. The default value is false. Values: true|false
- state
Return metric information for COMIDs within a specific state. Use a state's abbreviation to query for a given state. Syntax: state=<state1>,<state2>
- county
Return metric information for COMIDs within a specific county. Users must use the FIPS code, not county name, as a way to disambiguate counties. Syntax: county=<county1>,<county1>
- region
Return metric information for COMIDs within a specified hydroregion. Hydroregions are specified using full name i.e. 'Region01', 'Region03N', 'Region10L' Syntax: region=<regionid1>,<regionid2>
- conus
Return all COMIDs in the conterminous United States. The default value is false. Values: true|false
- countOnly
Return a CSV containing only the row count (ROWCOUNT) and the column count (COLUMNCOUNT) that the server expects to return in a request. The default value is false. Values: true|false
Examples
# \donttest{
df <- sc_get_data(comid='179', aoi='cat', metric='fert')
df <- sc_get_data(metric='pctgrs2006', aoi='ws', region='Region01')
df <- sc_get_data(metric='pctwdwet2006', aoi='ws', county='41003')
df <- sc_get_data(metric='pcturbmd2006', aoi='wsrp100',
comid='1337420')
df <- sc_get_data(metric='pcturbmd2006,damdens',
aoi='cat,ws', comid='179,1337,1337420')
df <- sc_get_data(metric='pcturbmd2006,damdens',
aoi='cat,ws', comid='179,1337,1337420',
showAreaSqKm='true', showPctFull='true')
df <- sc_get_data(metric='pcturbmd2006,damdens',
aoi='cat,ws', comid='179,1337,1337420', countOnly='true')
df <- sc_get_data(metric='thalwagdepth', comid='179,1337,1337420',aoi='other')
df <- sc_get_data(comid='179', aoi='ws', metric='all')
#> Using metric='all' with a large aoi may take a considerable amount of time to return results - request may timeout if multiple AOIs are requested
# }