Description Usage Arguments Details Value Examples
The WREG.GLS
function executes the multiple linear
regression analysis using generalized leastsquares regression.
1 2 3 
Y 
A numeric vector of the dependent variable of interest, with any transformations already applied. 
X 
A numeric matrix of the independent variables in the regression, with
any transformations already applied. Each row represents a site and each
column represents a particular independe variable. (If a leading constant
is used, it should be included here as a leading column of ones.) The rows
must be in the same order as the dependent variables in 
recordLengths 
A numeric matrix whose rows and columns are in the same
order as 
LP3 
A numeric matrix containing the fitted LogPearson Type III
standard deviate, standard deviation and skew for each site. The columns of
the matrix represent S, K, G, and an option regional skew value 
basinChars 
A dataframe containing three variables: 
transY 
A required character string indicating if the the dependentvariable was transformed by the common logarithm ('log10'), transformed by the natural logarithm ('ln') or untransformed ('none'). 
x0 
A vector containing the independent variables (as above) for a particular target site. This variable is only used for ROI analysis. 
alpha 
A numeric. 
theta 
A numeric. 
peak 
A logical. Indicates if the event being modeled is a peak flow
event or a lowflow event. 
distMeth 
A numeric. A value of 
regSkew 
A logical vector indicating if regional skews are provided with
an adjustment required for uncertainty therein ( 
MSEGR 
A numeric. The mean squared error of the regional skew. Required
only if 
TY 
A numeric. The return period of the event being modeled. Required
only for “GLSskew”. The default value is 
legacy 
A logical. A value of 
In this implementation, the weights for generalized leastsquares regression are defined by intersite correlations and record lengths. See manual for details.
The logical handle Legacy
has been included to test that this program
returns the same results as WREG v. 1.05. In the development of this code,
some idiosyncrasies of the MatLab code for WREG v. 1.05 became apparent.
Setting Legacy
equal to TRUE
forces the code to use the same
idiosycrasies as WREG v. 1.05. Some of these idosyncrasies may be bugs in
the code. Further analysis is needed. For information on the specific
idiosyncrasies, see the notes for the Legacy
input and the links to
other functions in this package.
All outputs are returned as part of a list. The elements of the list depend on the type of regression performed. The elements of the list may include:
Coefs 
A data frame composed of four variables: (1)

ResLevInf 
A data frame composed of four variables for each site in
the regression. 
LevLim 
The critical value of leverage.
See 
InflLim 
The critical value of influence.
See 
LevInf.Sig 
A logical matrix indicating if the leverage (column 1) is significant and the influence (column 2) is significant for each site in the regression. 
PerformanceMetrics 
A
list of not more than ten elements. All regression types return the mean
squared error of residuals ( 
X 
The input predictors. 
Y 
The input observations. 
fitted.values 
A vector of model estimates from the regression model. 
residuals 
A vector of model residuals. 
Weighting 
The weighting matrix used to develop regression estimates. 
Input 
A list of input parameters for error searching. Currently empty. 
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18  # Import some example data
peakFQdir < paste0(
file.path(system.file("exampleDirectory", package = "WREG"),
"pfqImport"))
gisFilePath < file.path(peakFQdir, "pfqSiteInfo.txt")
importedData < importPeakFQ(pfqPath = peakFQdir, gisFile = gisFilePath)
# Organizing input data
lp3Data < importedData$LP3f
lp3Data$K < importedData$LP3k$AEP_0.5
Y < importedData$Y$AEP_0.5
X < importedData$X[c("Sand", "OutletElev", "Slope")]
recordLengths < importedData$recLen
basinChars < importedData$BasChars
transY < "none"
# Run GLS regression
result < WREG.GLS(Y, X, recordLengths, LP3 = lp3Data, basinChars, transY)

Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.