segmentTS.4statsplots: Segment-based Statistics & Figures

Description Usage Arguments Value

Description

This function collates segment-based statistics based on the observed and simulated time-series.

Usage

1
2
3
segmentTS.4statsplots(obs.evnt, sim.evnt, ls.evnt.pos, obs.name = "obs",
  sim.name = "sim", time.units = "days", val.units = NULL,
  save.plot = FALSE, outDir = getwd(), region.name = NULL)

Arguments

obs.evnt

data.frame object for full time-series of observational data, from segmentTS.1matchsignal.

sim.evnt

data.frame object for full time-series of simulated data, from segmentTS.1matchsignal.

ls.evnt.pos

list object from segmentTS.3eqsignal with positions of the peaks and troughs in the full time-series. Defines the boundaries of the segments.

obs.name

name of observational data for table (string).

sim.name

name of simulated data for table (string).

time.units

units of time for calculating period length in the time-series; default is days.

val.units

units of the value for the variable in the time-series.

save.plot

save plot as a pdf (TRUE/FALSE); default is FALSE; default out is the current working directory.

outDir

location to save plot; default location is getwd()).

region.name

name of underlying region for table (string). Default is 'null_region'; not important unless evaluating multiple regions. At minimum, requires variables of values and date (YYYY-MM-DD)

Value

a data.frame object segment-based statistical summaries for all segments, obs and sim.


lcalle/segmentTS documentation built on May 7, 2019, 10:52 p.m.