getBasinChar: Collect and process basin characteristics for required...

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

Description

The function getBasinChar collects all of the basin characteristics in GAGES-II for a specific listofgages.

Usage

getBasinChar(listofgages, basinChars = NULL, destination = "",
  BC.code6.remflg = F, max.BC.oneval.frac = 0.5, debug.flg = F,
  keepWB = F)

Arguments

listofgages	Dataframe of gage numbers (as a character vector)
basinChars	(optional) A character vector that specifies certain variables to retrieve. The default is to retrieve all.
destination	(optional) A character string specfying a file name, without an extension, to which to write intermediate results. The default is not to save results.
BC.code6.remflg	(optional) A logical flag that indicates whether or not variables derived from a non-calibrated hydrologic model will be removed. The default, FALSE requests that these be retained.
max.BC.oneval.frac	(optional) A constant between 0 and 1, such that if at least that fraction of the BC values has a single value (usually zero) then the BC will be removed. The default is 0.5.
debug.flg	(optional) A logical indicating if verbose outputs are required from variable transformation. The default is FALSE.
keepWB	(optional) A logical passed to clean_BCs that indicates whether or not Water Balance model variables are retained. The default is FALSE.

Details

Lorem ipsum...

Value

The function returns a list as output. This list contains:

DescBCs	A data frame containing the station ID (STAID), drainage area (DRAIN_SQKM), and latitude and longitude in Albers projection (LAT_GAGE_UTM and LNG_GAGE_UTM) and decimal degrees (LAT_GAGE and LNG_GAGE) for the gage outlet and basin centroid (LAT_CENT and LoNG_CENT) for the listofgages.
AllBCs	A data frame containing all the variables in the database.
cleanBCs	A data frame of basin characteristics screened to remove categorical data or variables with a large proportion of identical variables.
winnowedBCs	A data frame of basin characteristics with correlations removed and climates aggregated to seasonal signals.
transf	A list of the variable transformations: transfBCsA data frame of basin characteristics with transformations for linearity applied. transf.infoA data frame describing all transformations applied. transfBC.VIFsA vector of the variance inflation factors (VIFs) of each bsin characteristic. transfBC.corrA square matrix of the correlations between basin characteristics.

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