readCompileFlow: Function to read and compile streamflow data for analysis

In wfarmer-usgs/PUBAD: Appliles and Analyzes Several Methods for Prediction in Ungaged Basins

Description

The function readCompileFlow collects the daily streamflow information available for a specified listofgages.

Usage

readCompileFlow(listofgages, units = c("cfs", "cms"), dataset_name = "",
  startDate = "", endDate = "", checkmiss = FALSE, keepNAdays = TRUE)

Arguments

listofgages	Dataframe of gage numbers (as a character vector)
units	Specifies the units of the output. Options include "cms" for cubic meters per second and "cfs" for cubic feet per second
dataset_name	Allows the user to specify a specific output location. Output will be saved as an R workspace. If no name is given, output data will be returned but not saved.
startDate	Specifies a particular date from which to begin retrieving the streamflow data. Format should be "YYYY-MM-DD". If blank, all available data will be retrieved.
endDate	Specifies a particular date up to which to retrieve the streamflow data. Format should be "YYYY-MM-DD". If blank, all available data will be retrieved.
checkmiss	Logical. If TRUE, if any day is missing a streamflow value for a given site, none of the data for that site will be collected. If FALSE, missing days will be allowed.
keepNAdays	Logical.If TRUE, if there is a day of flow missing, the date will be included with an NA streamflow value. If FALSE, only dates with streamflow data will be collected. This input is only valid if checkmiss=FALSE.

Details

Lorem ipsum...

Value

The function returns a zoo object of observed streamflows.

wfarmer-usgs/PUBAD documentation built on May 4, 2019, 5:21 a.m.