CFClimatology {CFtime} | R Documentation |
CFClimatology class
Description
This class represents a climatological time coordinate, both its "calendar" and its "climatology" bounds values.
The "calendar" portion is managed by the CFTime class, from which this class is inherited. This class implements the specific behaviour of the climatological bounds values and includes methods to query the structure of the climatological data.
Super class
CFtime::CFTime
-> CFClimatology
Active bindings
period
(read-only) Character string indicating the period during the year over which the climatology was calculated.
years
(read-only) Vector of two integer values indicating the years over which the climatology was calculated.
friendlyClassName
Character string with class name for display purposes.
Methods
Public methods
Inherited methods
CFtime::CFTime$POSIX_compatible()
CFtime::CFTime$as_timestamp()
CFtime::CFTime$cut()
CFtime::CFTime$equidistant()
CFtime::CFTime$factor()
CFtime::CFTime$factor_coverage()
CFtime::CFTime$factor_units()
CFtime::CFTime$format()
CFtime::CFTime$get_bounds()
CFtime::CFTime$indexOf()
CFtime::CFTime$range()
CFtime::CFTime$set_bounds()
CFtime::CFTime$slice()
Method new()
Create a new instance of this class.
Usage
CFClimatology$new(definition, calendar = "standard", offsets, bounds)
Arguments
definition
Character string of the units and origin of the calendar.
calendar
Character string of the calendar to use. Must be one of the values permitted by the CF Metadata Conventions. If
NULL
, the "standard" calendar will be used.offsets
Numeric or character vector. When numeric, a vector of offsets from the origin in the time series. When a character vector of length 2 or more, timestamps in ISO8601 or UDUNITS format.
bounds
The climatological bounds for the offsets. A
matrix
with columns foroffsets
and low values in the first row, high values in the second row. The bounds will oftentimes overlap or be discontinuous.
Method print()
Print a summary of the CFClimatology
object to the console.
Usage
CFClimatology$print(...)
Arguments
...
Ignored.
Returns
self
invisibly.
Method clone()
The objects of this class are cloneable with this method.
Usage
CFClimatology$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.
References
https://cfconventions.org/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#climatological-statistics