stfl_extract_station_predictions: Extract the station level predictions from a trend fit, both...

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

Description

Extract the station level predictions from a trend fit, both single-station-single-statistic and multi-station-multi-stat cases.

Usage

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

Arguments

fit	Results from stfl_trend_1stn_1stat() or stfl_trend_kstn_kstat() 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 <- "08NM116"
data <- stfl_get_annual_stat(station.id, Statistic=c("MEAN"))
res <- stfl_trend_1stn_1stat(data, log.Y=TRUE)
stfl_extract_station_predictions(res)
stfl_extract_station_predictions(res, transpose=TRUE)
stfl_extract_station_predictions(res, transpose=TRUE, methods="LM")

## End(Not run)
#'

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