stfl_extract_regional_predictions: Extract the regional predictions from a regional fit

In bcgov/StreamFlowTrend: Trend analysis on annual streamflow metrics from HYDAT database

Description

Extract the regional predictions from a regional fit

Usage

stfl_extract_regional_predictions(
  fit,
  methods = c("LM", "MK", "LMrob"),
  transpose = FALSE
)

Arguments

fit	Results from stfl_trend_regional() fit
methods	Which methods should be used to estimate trend lines. Possible values are one or more of LM: Ordinary regression using the lm() function MK: Mann-Kendall estimates using Sen estimator LMrob: Robust linear regression fit using the lmrob() function from the robustbase package
transpose	If set to TRUE, then converts from wide-format to long-format.

Value

Returns a data.frame with the extracted predictions in a wide format and in long format if transpose=TRUE.

Examples

## Not run: 
# needs the HYDAT package installed
station.id <- c("08NM053","08NM116")
mydata <- stfl_get_annual_stat(station.id, Statistic=c("MEAN"))
mydata$REGION <- "AnyOldRegion"
mystation.weights <- data.frame(STATION_NUMBER=station.id, WEIGHT=c(2,1))
fit <- stfl_trend_regional(mydata, mystation.weights, log.Y=TRUE)
stfl_extract_regional_predictions(fit)

## End(Not run)
#'

bcgov/StreamFlowTrend documentation built on Dec. 19, 2021, 7:38 a.m.