print: Print summary of WREG results

In wfarmer-usgs/WREG: USGS WREG v. 3.00

Description

Print methods for WREG output lists

Usage

## S3 method for class 'WREG.OLS'
print(x, ...)

## S3 method for class 'WREG.WLS'
print(x, ...)

## S3 method for class 'WREG.GLS'
print(x, ...)

## S3 method for class 'WREG.GLSs'
print(x, ...)

Arguments

x	An output list from one of the WREG functions
...	further arguments passed to or from other methods.

Value

print.WREG.OLS Prints a summary of output list from WREG.OLS

print.WREG.WLS Prints a summary of output list from WREG.WLS

print.WREG.GLS Prints a summary of output list from WREG.GLS

print.GLSs Prints a summary of output list from WREG.GLS with an adjustment for uncertainty in the skewness

Note

print is a generic name for the functions documented.

If called, print displays a summary of the output from WREG functions

Examples

## print.WREG.OLS
# 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)

# Run a simple regression
Y <- importedData$Y$AEP_0.5
X <- importedData$X[c("Sand", "OutletElev", "Slope")]
transY <- "none"
result <- WREG.OLS(Y, X, transY)
print(result)
## print.WREG.WLS
# 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
transY <- "none"

# Run WLS regression
result <- WREG.WLS(Y, X, recordLengths, LP3 = lp3Data, transY)
print(result)
## print.WREG.GLS
# 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)
print(result)
## print.WREG.GLS
# 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 with uncertainty in the skewness
result <- WREG.GLS(Y, X, recordLengths, LP3 = lp3Data, basinChars, transY, 
  regSkew = TRUE, MSEGR = 0.302)
print(result)

wfarmer-usgs/WREG documentation built on July 24, 2020, 1:28 a.m.