colwell_stats: Environmental time series metrics from Colwell (1974)

Description Usage Arguments Value Author(s) See Also Examples

View source: R/colwell_stats.R

Description

Calculates Constancy (C), Contingency (M), and Predictability (P) metrics from Colwell (1974) for seasonally varying environmental data.

Usage

1
colwell_stats(time_series, dates, n_states = 11)

Arguments

time_series

A numeric vector containing a raw environmental time series.

dates

An vector of class Date of format YYYY-MM-DD (must be in progressive chronological order).

n_states

is a numeric vector of length 1 containing a somewhat arbitrary number, as Colwell's method divides a continuous variable up into discrete states. Default (arbitrary) is 11. See Details.

Value

A data.frame.

Author(s)

Diego Barneche and Scott Burgess.

See Also

seasonality_and_colour, env_stats.

Examples

1
2
3
4
5
6
7
library(envPred)
data(sst)
data(npp)
n_states <- 11
fct <- envPred:::colwell_stats
fct(sst$time_series, sst$dates, n_states)
fct(npp$time_series, npp$dates, n_states)

dbarneche/envPred documentation built on June 28, 2020, 5:04 p.m.