extractQuantiles: Quantiles of simulated signal and noise spectrum realizations

View source: R/EstimateCI.R

extractQuantilesR Documentation

Quantiles of simulated signal and noise spectrum realizations

Description

Extract lower and upper quantiles across the signal, noise and SNR realizations from a run of runSurrogates, scaled to the respective mean estimates of the realiztaions.

Usage

extractQuantiles(surrogates, probs = c(0.1, 0.9), minval = 1e-15)

Arguments

surrogates

the output from a run of runSurrogates.

probs

length-2 numeric vector of probabilities with values in [0,1]; default setting extracts the 10 and 90 % quantiles.

minval

minimum value assigned to negative estimates of the scaled lower and upper quantiles to avoid unphysical negative confidence intervals, thereby preventing issues on logarithmic plots.

Value

a named list of the three elements 'signal', 'noise', and 'snr', with each list element in turn being a named list with the 'lower' and 'upper' quantiles (according to the setting of probs) across the simulated signal, noise and signal-to-noise ratio (SNR) spectra.

Author(s)

Thomas Münch

See Also

runSurrogates


EarthSystemDiagnostics/proxysnr documentation built on June 9, 2025, 11:58 a.m.