xcorPlot: Exploring correlation function

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

Description

xcorPlot explores the fit of the proposed approximation of cross-correlation.

Usage

xcorPlot(object, alpha, theta, concurrentMin, DistMeth = 2, plot = TRUE)

Arguments

object	A list of the imported data from importPeakFQ orimportWREG.
alpha	A number, alpha is a parameter used in the estimated cross-correlation between site records. See equation 20 in the WREG v. 1.05 manual.
theta	A number, theta is a parameter used in the estimated cross-correlation between site records. See equation 20 in the WREG v. 1.05 manual.
concurrentMin	A number specifying the minimum number of years of concurrent record required to estimate cross-correlation.
DistMeth	A value of 1 indicates that the "Nautical Mile" approximation should be used to calculate inter-site distances. A value of 2 designates the Haversine approximation. See Dist.WREG.
plot	A logical spcifying if the plot should be created.

Value

If plot=FALSE, the Nash-Sutcliffe model efficieny is returned.

Examples

# 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)

# Build cross-correlation plot
xcorPlot(object = importedData, alpha = 0.01, theta = 0.98,
  concurrentMin = 10)

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