ax.freqlab: Frequency axis label

In thomas-muench/tmlibr: My Personal R Library of Miscellaneous Auxiliary Functions.

Description

Provides the frequency axis label for spectral plots in optional units.

Usage

ax.freqlab(label = if (!inverse) "Frequency" else "Time period",
  unit = "yr", font = par()$font.axis, inverse = FALSE)

Arguments

label	the label for the frequency axis; defaults to "Frequency" for inverse = FALSE, else to "Time period".
unit	the time unit of the corresponding frequency axis; defaults to years ("yr").
font	An integer which specifies which font to use for text. Defaults to the axis font currently set by par; see ?par for the available options.
inverse	logical; if TRUE, use inverse frequency units, i.e. time periods.

Value

A language object with the axis label.

Author(s)

Thomas Münch

Examples

plot(1 : 10, xlab = ax.freqlab(),
             ylab = ax.freqlab(unit = "s", inverse = TRUE, font = 2))

thomas-muench/tmlibr documentation built on May 26, 2019, 10:36 a.m.