ONI_reps: ONI replicates

Description Usage Arguments Value

View source: R/generator.R

Description

Generate multiple stochastic replicates of ONI time series according to Burgers (1999).

Usage

1
2
ONI_reps(ONI.obs, years = NULL, num.reps = 100, trim = 2,
  var.cor = TRUE)

Arguments

ONI.obs

A data frame of observed ONI with three columns (year, month, ONI). By default, the replicates will have the same years as ONI.obs, unless years is provided.

years

If provided, the replicates will have these years.

num.reps

Number of replicates to be generated. Default is 100.

trim

Used to cut off values that are too high or too low. Values that are more than trim * max(abs(obs)) will be set to max(abs(obs)). Default is 2. Supply trim = NULL if you don't want trimming.

var.cor

Whether variance correction is performed. Setting var.cor = TRUE will ignore trim.

Value

A data.table of 4 columns (rep, year, month, ONI).


ntthung/shy documentation built on May 7, 2019, 4:42 p.m.