pastecs: GetUnitText – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

GetUnitText

Format a nice time units for labels in graphs

Description

This is an internal function called by some plot() methods. Considering the time series 'units' attribute and the frequency of the observations in the series, the function returns a string with a pertinent time unit. For instance, if the unit is 'years' and the frequency is 12, then data are monthly sampled and GetUnitText() returns the string "months"

Usage

GetUnitText(series)

Arguments

series

a regular time series (a 'rts' object in Splus, or a 'ts' object in R)

Value

a string with the best time unit for graphs

Author(s)

Philippe Grosjean (phgrosjean@sciviews.org), Frédéric Ibanez (ibanez@obs-vlfr.fr)

Examples

timeser <- ts(1:24, frequency=12)           # 12 observations per year
if (exists("is.R") && is.function(is.R) && is.R()) {  # We are in R
attr(timeser, "units") <- "years"           # time in years for 'ts' object
} else {                                              # We are in Splus
attr(attr(timeser, "tspar"), "units") <- "years" # Idem for Splus 'rts' object
}
GetUnitText(timeser)                        # formats unit (1/12 year=months)

pastecs

Package for Analysis of Space-Time Ecological Series

v1.3.21

GPL-2

Authors

Philippe Grosjean [aut, cre], Frederic Ibanez [aut], Michele Etienne [ctb]

Initial release