Function to return LakeCat 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
lc_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 Syntax: name=<name1>,<name2>
- aoi
Specify the area of interest described by a metric. By default, all available areas of interest for a given metric are returned. Syntax: areaOfInterest=<value1>,<value2> Values: catchment|watershed|
- 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 <- lc_get_data(comid='23794487', aoi='cat', metric='fert')
df <- lc_get_data(metric='pcturbmd2006', aoi='ws',
comid='24083377')
df <- lc_get_data(metric='pctgrs2006', aoi='ws', region='Region01')
df <- lc_get_data(metric='pctwdwet2006', aoi='ws', county='41003')
df <- lc_get_data(metric='pcturbmd2006', aoi='ws',
comid='24083377', showAreaSqKm=FALSE, showPctFull=TRUE)
df <- lc_get_data(metric='pcturbmd2006,damdens',
aoi='cat,ws', comid='23783629,23794487,23812618')
df <- lc_get_data(metric='pcturbmd2006,damdens',
aoi='cat,ws', comid='23783629,23794487,23812618',
countOnly=TRUE)
df <- lc_get_data(comid='23783629', aoi='ws', metric='all')
# }