importWREG_General: Import Data from Generic (v1.06) Files

In USGS-R/WREG: USGS WREG v. 2.02

Description

The importWREG_General function reads the WREG inputs from a directory set up with new generic file formats.

Usage

importWREG_General(wregPath)

Arguments

wregPath

A directory that contains all of the files needed to implement the MatLab version of WREG.

Details

This function allows users to use a more streamlined data format: only two or three files are required. This includes the “SiteInfo.txt”, “USGSAnnualTimeSeries.txt”, and, optionally, “UserWLS.txt”. The “SiteInfo.txt” file should contain the following columns (with headers in parentheses): the station identification number (stationID), the latitude and longitude of the stations (latitude and longitude), the regional skew computed for each site (regionalSkew), the at-site skew value (skew), the standard deviation of the Log-Pearson Type-III distribution used to fit the series (standardDeviation), a series of streamflow characteristics to be evaluated (Q#, where # indicates a specific return period), Q#.k (the characteristic-specific kappa value from the fitted Log-Pearson Type-III distribution, where again # specifies a certain return period), and any explanatory variables to be used for analysis. The “USGSAnnualTimeSeries.txt” and “UserWLS.txt” files follow the format outlined in USGS Techniques and Methods 4-A8.

Value

All outputs are returned as part of a list. The list includes:

sites	A vector of site IDs.
Y	A data frame whose comlumns represent unique frequency events, while the row represent particular sites in the same order as sites.
X	A data frame whose columns represent basin characteristics to be used as dependent variables and whose rows represent sites corresponding to sites.
LP3f	A matrix containing the fitted LP# parameters that are fixed across exceedence probability. These include the standard deviation, skew and regional skew for each site.
LP3k	A matrix of the fitted kappa parameters of the LP3 distribution for each AEP.
BasChars	A matrix containing the site IDs, latitudes and longitudes.
recLen	A square matrix indicating the number of overlapping years for each site pair.
recCor	A matrix of the correlaiton between site paris.
UW	A matrix of user weights, if included.

Examples

wregDir <- file.path(system.file("exampleDirectory", package = "WREG"),
 "generalImport")
importedData <- importWREG_General(wregPath = wregDir)

USGS-R/WREG documentation built on May 9, 2019, 6:48 p.m.