dbhydro.stn: An API for station-level DBHYDRO water quality data

View source: R/dbhydro_stn.R

dbhydro.stnR Documentation

An API for station-level DBHYDRO water quality data

Description

Downloads DBHYDRO water quality data for specified stations

Usage

dbhydro.stn(destfile = "stn_report_todaysDate.csv",
stations = c("ACRA1"),
rename_proj = TRUE,
parameters = "all",
report_type = "full", # full = long dataset - 1 line per sample; crosstab = wide dataset
incl_qc_flags = TRUE,
incl_flagged_data = FALSE,
destination = "file_csv", 
start_date = "01-JAN-1960", # note format
end_date   = "today",
import_data = FALSE)

Arguments

destfile

a character vector file address for output, saved as a comma-delimited text file.

stations

a character vector of station names. If one station in the list returns no data, the entire url request fails.

rename_proj

lorem ipsum

parameters

lorem ipsum

report_type

lorem ipsum

incl_qc_flags

lorem ipsum

incl_flagged_data

lorem ipsum

destination

lorem ipsum

start_date

lorem ipsum

end_date

lorem ipsum

import_data

Logical; should data be returned as R object (and not saved to file)?

Value

dataframe dbhydro.stn saves a csv of DBHYDRO water quality data to disk or returns a dataframe.

See Also

dbhydro.stn.batch is preferred for multiple-station downloads.

Examples

## Not run: 
head(dbhydro.stn())

## End(Not run)


troyhill/SFNRC documentation built on Dec. 30, 2024, 4:32 p.m.