CFtime-function

CFtime

This function creates an instance of the CFTime class. The arguments to the
call are typically read from a CF-compliant data file with climatological
observations or climate projections. Specification of arguments can also be
made manually in a variety of combinations.

Support for all calendars as specified in the Climate and Forecast
(CF) Metadata Conventions for climate and forecasting data. The CF Metadata
Conventions is widely used for distributing files with climate observations
or projections, including the Coupled Model Intercomparison Project (CMIP)
data used by climate change scientists and the Intergovernmental Panel on
Climate Change (IPCC). This package specifically allows the user to work
with any of the CF-compliant calendars (many of which are not compliant with
POSIXt). The CF time coordinate is formally defined in the CF Metadata
Conventions document available at <https://cfconventions.org/Data/cf-conventions/cf-conventions-1.12/cf-conventions.html#time-coordinate>.

Patrick Van Laake

Using CF-Compliant Calendars with Climate Projection Data

CFtime-function function

<dl><dt>definition</dt>
<dd>A character string describing the time coordinate.</dd>
<dt>calendar</dt>
<dd>A character string describing the calendar to use with the
time dimension definition string. Default value is "standard".</dd>
<dt>offsets</dt>
<dd>Numeric or character vector, optional. 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. When a character
string, a timestamp in ISO8601 or UDUNITS format and then a time series
will be generated with a separation between steps equal to the unit of
measure in the definition, inclusive of the definition timestamp. The unit
of measure of the offsets is defined by the time series definition.</dd></dl>

Arguments

Create a CFTime object — CFtime-function

<dl>

<dt>definition</dt>
<dd>A character string describing the time coordinate.</dd>


<dt>calendar</dt>
<dd>A character string describing the calendar to use with the
time dimension definition string. Default value is "standard".</dd>


<dt>offsets</dt>
<dd>Numeric or character vector, optional. 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. When a character
string, a timestamp in ISO8601 or UDUNITS format and then a time series
will be generated with a separation between steps equal to the unit of
measure in the definition, inclusive of the definition timestamp. The unit
of measure of the offsets is defined by the time series definition.</dd>

</dl>

CFtime-function: Create a CFTime object

Description

Usage

Value

Arguments

Examples