TS_sample_helper: Helper-function for 'TS_sample'

In LAJordanger/localgaussSpec: Local Gaussian Spectral Analysis

Helper-function for TS_sample

Description

This internal function is a helper-function for TS_sample, which based on the TS_key and the specified arguments performs an initial sanity test and then returns the function needed for the desired simulation.

Usage

TS_sample_helper(TS_key, ...)

Arguments

TS_key	character, key that selects one of the time series from TS_families
...	dotsMethods (i.e. optional), any arguments to be delivered to the function selected by TS_key.

Details

Given a TS_key (the name of a sublist of TS_families), and relevant parameters for it (delivered by the dotsMethods-argument ...), this function will return the function that will be used in TS_sample to generate the desired sample from the specified time series.

Value

This function returns a list with the following five nodes to the internal workflow of TS_sample:

fun

A local copy of the desired function, which can generate the desired time series. Note that the formals of the function selected by TS_key will have been updated with the parameters given via the dotsMethods-argument.

args.i

A list with the (updated) default values that are used by the function in fun.

args.f

A character-string of the given values.

TS_key

The TS_key-value given to this function.

fun_data

An updated version of the TS_key-sublist of TS_families, in which the arguments have been updated based on the values given to the ...-argument.

LAJordanger/localgaussSpec documentation built on May 6, 2023, 4:31 a.m.