format_qd: Format quickest detection results for plotting

Description Usage Arguments Value Examples

View source: R/quickest_detection.R

Description

Format quickest detection results for plotting

Usage

1
2
3
4
5
6
7
8
format_qd(
  qd_stats,
  var_cols = c("Manual_Chl", "BGA_HYLB", "DO_Sat", "pH"),
  stats = c("SD", "Ar1"),
  bloom_fert_df = bloom_fert_dates,
  exp_lakes = c("T", "R"),
  just_alarm_DOYs = FALSE
)

Arguments

qd_stats

data frame, output from run_qd

var_cols

character vector, variable names that are columns of *data* containing time series to calculate rolling window stats on

stats

character vector, statistics to format alarms for, default = c("SD", "Ar1)

bloom_fert_df

data frame of fertilization start and end dates, see bloom_fert_dates for default and formatting

exp_lakes

character vector, values in *Lake* column of qd_stats that correspond to experimental lakes

just_alarm_DOYs

TRUE or FALSE (default), should results be filtered to just DOYs that have an alarm (in any variable)?

Value

data frame with quickest detection alarm info

Examples

1
2
3
rw_stats <- calc_rolling_stats(ts_data, var_cols = c("DO_Sat"))
qd_stats <- run_qd(rw_stats, var_cols = c("DO_Sat"))
qd_alarms <- format_qd(qd_stats, var_cols = c("DO_Sat"))

cbuelo/tvsews documentation built on Jan. 21, 2022, 1:31 a.m.