Function to get all NNI data available for a given year.
Usage
lc_get_nni(
year,
aoi = NULL,
comid = NULL,
showAreaSqKm = TRUE,
showPctFull = NULL,
countOnly = NULL
)Arguments
- year
Years(s) of NNI metrics to query. Only valid NNI years are accepted (1987:2017) Syntax: year=<year1>,<year2>
- 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
- comid
Return metric information for specific COMIDs Syntax: comid=<comid1>,<comid2>
- showAreaSqKm
Return the area in square kilometers of a given area of interest. The default value is true. Values: true|false
- showPctFull
Return the pctfull for each dataset. 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_nni(year='1987, 1990, 2005, 2017', aoi='cat,ws',
comid='23783629,23794487,23812618')
#> One or more of the provided metric names do not match the expected metric names in StreamCat. Use lc_get_params(param='metric_names') to list valid metric names for StreamCat
df <- lc_get_nni(year='2015', aoi='cat',
comid='23783629', countOnly=TRUE)
#> One or more of the provided metric names do not match the expected metric names in StreamCat. Use lc_get_params(param='metric_names') to list valid metric names for StreamCat
df <- lc_get_nni(comid='23783629', year='2011, 2012', aoi='ws')
#> One or more of the provided metric names do not match the expected metric names in StreamCat. Use lc_get_params(param='metric_names') to list valid metric names for StreamCat
# }