PlotTF: Plot transfer functions (Figure B1 in Münch and Laepple,...

View source: R/paper-plotting-functions.R

PlotTFR Documentation

Plot transfer functions (Figure B1 in Münch and Laepple, 2018)

Description

Plot the spectral transfer functions of the effects of diffusion and time uncertainty.

Usage

PlotTF(
  dtf = NULL,
  ttf = NULL,
  names = NULL,
  col = NULL,
  dtf.threshold = NULL,
  xlim = c(500, 2),
  ylim1 = c(0.005, 5),
  ylim2 = c(0.2, 1.5),
  plt.ann = "default",
  xlab = NULL,
  ylab1 = NULL,
  ylab2 = NULL,
  xtm = NULL,
  ytm1 = NULL,
  ytm2 = NULL,
  xtl = NULL,
  ytl1 = NULL,
  ytl2 = NULL
)

Arguments

dtf

A list of transfer function data sets: each data set is an object of class "spec" (see ?spectrum) with minimum components freq and spec, or simply a named list with these two, where component freq is a numeric vector providing a frequency axis and component spec a numeric vector with the corresponding diffusion transfer function values. If NULL (the default), the diffusion transfer function provided with the package is plotted, which corresponds to Figure B1 in Münch and Laepple (2018).

ttf

As dtf but providing time uncertainty transfer functions. If NULL (the default), the time uncertainty transfer function provided with the package is plotted, which corresponds to Figure B1 in Münch and Laepple (2018).

names

an optional character vector of names for the transfer function data sets. If NULL, the names of dtf and ttf are used or, if not present, default names. If the diffusion and time uncertainty data sets differ in number, you can provide a list of two vectors of names.

col

a numeric or character vector of colors to use for the plotting; if NULL default colors are used.

dtf.threshold

optional critical diffusion transfer function value to plot a corresponding horizontal line and vertical lines of corresponding frequency cutoff values (omitted for NULL).

xlim

the x limits (x1, x2) of the plot.

ylim1

the y limits (y1, y2) of the diffusion transfer function plot.

ylim2

the y limits (y1, y2) of the time uncertainty transfer function plot.

plt.ann

if "default" use axis annotation as in Fig. B1 of Münch and Laepple (2018). Since no other fixed annotation scheme is implemented, setting plt.ann to a different value will result in an error.

xlab

if not NULL use this specific x axis label to override the default setting.

ylab1

if not ‘NULL’ use this specific y axis label for the first plot to override the default setting.

ylab2

if not ‘NULL’ use this specific y axis label for the second plot to override the default setting.

xtm

if not NULL use this vector of specific x axis tick mark positions to override the default setting.

ytm1

as xtm for the first y axis.

ytm2

as xtm for the second y axis.

xtl

x axis tick mark labels. If xtm is not NULL, xtl is used for the labels parameter of the axis function: if xtl is set to NULL, the labels are determined automatically, else set it explicitly by specifying a vector of labels of the same length as xtm; see also ?axis.

ytl1

as xtl for the first y axis.

ytl2

as xtl for the second y axis.

Author(s)

Thomas Münch

References

Münch, T. and Laepple, T.: What climate signal is contained in decadal- to centennial-scale isotope variations from Antarctic ice cores? Clim. Past, 14, 2053–2070, https://doi.org/10.5194/cp-14-2053-2018, 2018.

Examples

# Plot Figure B1 in Münch and Laepple (2018), i.e. the used transfer
# functions to correct the DML and WAIS isotope spectra:

PlotTF(names = c("DML1", "DML2", "WAIS"), dtf.threshold = 0.5,
       col = c("black", "firebrick", "dodgerblue"))

EarthSystemDiagnostics/proxysnr documentation built on April 27, 2024, 8:24 p.m.