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).
sc_get_data(
comid = NULL,
metric = NULL,
aoi = NULL,
showAreaSqKm = NULL,
showPctFull = NULL,
state = NULL,
county = NULL,
region = NULL,
conus = NULL,
countOnly = NULL,
validate = FALSE
)Return metric information for specific COMIDs. Can be a comma-delimited list, a character vector,
or any object that can be coerced to a comma-delimited list with paste.
One of comid, county, state, or region is required unless conus='true'.
Syntax: comid=<comid1>,<comid2>
Name(s) of metrics to query. Must be character string with comma-delimited list of metrics,
or, if metric='all' then all metrics will be queried. Not case-sensitive.
Syntax: name=<name1>,<name2>
Name(s) of areas of interest to query.
If a metric does not have data for a given AOI, no data is returned for that AOI.
Certain metrics that have no AOI specified for StreamCat need the AOI to be specified as 'other'. These
metrics include: BankfullDepth, BankfullWidth, ThalwagDepth (sic), CHEM_V2_1, CONN, HABT, HYD, ICI, IWI, TEMP, WettedWidth,
prg_bmmi, and all the mast, msst, mwst metrics. Case-sensitive.
Syntax: areaOfInterest=<value1>,<value2> Values: cat|ws|catrp100|wsrp100|other
Return the area in square kilometers of a given area of interest. The default value is false. Values: true|false
Return the pctfull for each dataset. The default value is false. Values: true|false
Return metric information for COMIDs within a specific state. Use a state's abbreviation to
query for a given state. One of comid, county, state, or region is required unless conus='true'.
If specified and valid, comid and county are ignored. Case-sensitive.
Syntax: state=<state1>,<state2>
Return metric information for COMIDs within a specific county.
Users must use the FIPS code, not county name, as a way to disambiguate counties.
One of comid, county, state, or region is required unless conus='true'. If specified and valid, comid is ignored.
Syntax: county=<county1>,<county1>
Return metric information for COMIDs within a specified hydroregion.
Hydroregions are specified using full name i.e. 'Region01', 'Region03N', 'Region10L'
One of comid, county, state, or region is required unless conus='true'.
If specified and valid, comid, county, and state are ignored. Case-sensitive.
Syntax: region=<regionid1>,<regionid2>
Return all COMIDs in the conterminous United States. Character string (Not case-sensitive) or logical.
The default value is false. If true, comid, county, state, and region are ignored.
Values: true|false
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
Logical. If TRUE, validate supplied COMIDs using the upstream NLDI service before calling the StreamCat API. The default is FALSE to avoid external NLDI calls during routine data retrieval.
A data frame of StreamCat metrics. If data are missing for all rows of a given metric, then the column for that metric will not exist. If data are missing for only some rows, then they will be specified with NA.
if (FALSE) { # \dontrun{
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='ws,rp100',
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(metric='thalwagdepth', comid=c('179','1337','1337420'), aoi='other')
df <- sc_get_data(comid='179', aoi='ws', metric='all')
} # }