paleodata_processing: Wrapper function for processing of datasets using various...

View source: R/Proxytools_tools.R

paleodata_processingR Documentation

Wrapper function for processing of datasets using various processing methods

Description

Input data –> filtering –> interpolation –> time restriction (windowing) –> transformation –> signal extraction –> output data

Usage

paleodata_processing(
  xin,
  filtering = FALSE,
  filter_type = NULL,
  filter_scales = NULL,
  detr_scale = NULL,
  smooth_scale = NULL,
  interpolation = FALSE,
  interpolation_type = NULL,
  interpolation_dates = NULL,
  windowing = FALSE,
  start_date = NULL,
  end_date = NULL,
  transformation = FALSE,
  transformation_type = NULL,
  signal_extraction = FALSE,
  signal_type = NULL,
  signal_components = NA
)

Arguments

xin

Proxytibble with proxy data in 'zoo::zoo' format, or irregular time series object ('zoo::zoo'), xin can be multivariate

filtering

Logical: should filtering be applied

filter_type

Parameters for filtering (see paleodata_filtering)

filter_scales

Parameters for filtering (see paleodata_filtering)

detr_scale

Parameters for filtering (see paleodata_filtering)

smooth_scale

Parameters for filtering (see paleodata_filtering)

interpolation

Logical: should interpolation be applied?

interpolation_type

Parameters for interpolation (see paleodata_interpolation)

interpolation_dates

Parameters for interpolation (see paleodata_interpolation)

windowing

Logical: should restriction to time window be applied?

start_date

Parameters for windowing (see paleodata_windowing)

end_date

Parameters for windowing (see paleodata_windowing)

transformation

Logical: should transformation be applied?

transformation_type

Parameters for transformation (see paleodata_transformation)

signal_extraction

Logical: should signal extraction be applied?

signal_type

Parameters for signal extraction (see paleodata_signal_extraction)

signal_components

Parameters for signal extraction (see paleodata_signal_extraction)

Value

Proxytibble with proxy data in 'zoo::zoo' format or irregular time series object ('zoo::zoo') containing the processed signals

See Also

paleodata_filtering (from 'PTBoxProxytools') for filtering

paleodata_interpolation (from 'PTBoxProxytools') for interpolation

paleodata_windowing (from 'PTBoxProxytools') for time period restriction

paleodata_transformation (from 'PTBoxProxytools') for transformation

paleodata_signal_extraction (from 'PTBoxProxytools') for signal extraction

Examples

#' # Load ice core example data
library(PTBoxProxydata)
mng <- ProxyDataManager()
icecoredata <- load_set(mng,'icecore_testset',zoo_format = 'zoo')
# Step-by-step processing of ice core data: 1) Bandpass filter, 2) Interpolate to common time axis, 3) Restrict to 30-60ka BP, 4) Normalize, 5) Compute 1. PC
icecoredata_processed <- paleodata_processing(icecoredata, filtering = TRUE, filter_type = "bandpass", filter_scales = data.frame(lower=1000, upper=10000),
                                                           interpolation = TRUE, interpolation_type = "spectral", interpolation_dates = seq(20000,70000,by=100),
                                                           windowing = TRUE, start_date = 30000, end_date = 60000,
                                                           transformation = TRUE, transformation_type = "normalize",
                                                           signal_extraction = TRUE, signal_type = "pca", signal_components = 1)
# Plotting
plot(icecoredata_processed[[1]]$proxy_data[[1]])
plot(icecoredata_processed[[2]]$proxy_data[[1]])
plot(icecoredata_processed[[3]]$proxy_data[[1]])


paleovar/ptboxproxytools documentation built on June 9, 2025, 1:40 a.m.