list_datasets: Get a vector of timeseries dataset names

View source: R/list_datasets.R

list_datasetsR Documentation

Get a vector of timeseries dataset names

Description

list_datasets(site) returns the data available to a specific site. In contrast, get_var_src_codes(out="var_src") returns a list of all possible variables.

Usage

list_datasets(site_name, data_type = c("ts", "watershed"),
  with_ts_version = "rds", with_ts_archived = FALSE,
  with_ts_uploaded_after = "2015-01-01", limit = 10000)

Arguments

site_name

a character vector of length one with a site name such as those returned from make_site_name()

data_type

character. one or more dataset types to return

with_ts_version

one or more of c('rds','tsv') to limit the dataset extension to anything in with_ts_version (if the dataset is a ts)

with_ts_archived

one or more of c(TRUE,FALSE) to limit the list to sites that have a ts that's archived, not archived, or either

with_ts_uploaded_after

POSIXct, or convertible to POSIXct, giving date after which a ts must have been uploaded to count

limit

integer. the maximum number of items to return

Value

an alphabetically sorted character vector of unique timeseries variable names (in var_src format)for given sites

Examples

## Not run: 
list_datasets(site_name = 'nwis_01021050')

## End(Not run)

USGS-R/mda.streams documentation built on June 3, 2023, 8:43 a.m.