WaverideR (version 0.4.1)

percentile_from_red_noise: Calculate average spectral power from red noise curves for a given percentile

Description

The percentile_from_red_noise function is used to generate and average spectral power curve based on a set percentile based. To generate the percentile curve the results of the model_red_noise_wt function are used.

Usage

percentile_from_red_noise(red_noise = NULL, wavelet = NULL, percentile = NULL)

Value

Returns a matrix with 2 columns.

The first column is the period (m).

The second column is the spectral power at percentile x based on

the red noise modelling runs.

Arguments

red_noise

Red noise curves generated using the model_red_noise_wt function.

wavelet

Wavelet object created using the analyze_wavelet function.

percentile

Percentile value (0-1).

Examples

# \donttest{
#'#generate average spectral power curves based on red noise curves which are
# based on the magnetic susceptibility record of the Sullivan core of Pas et al., (2018)

mag_wt <- analyze_wavelet(data = mag,
dj = 1/100,
lowerPeriod = 0.1,
upperPeriod = 254,
verbose = FALSE,
omega_nr = 10)

#increase n_simulations to better define the red noise spectral power curve
mag_wt_red_noise <- model_red_noise_wt(wavelet=mag_wt,
n_simulations=10, # Increase number for a better constrained result
run_multicore=FALSE,
verbose=FALSE)


prob_curve <- percentile_from_red_noise(
red_noise = mag_wt_red_noise,
wavelet = mag_wt,
percentile = 0.9)

# }