CFAxisTime: Time axis object
In ncdfCF: Easy Access to NetCDF Files with CF Metadata Conventions
CFAxisTime R Documentation
Time axis object
Description
This class represents a time axis. The functionality is provided
by the CFTime class in the CFtime package.
Super classes
ncdfCF::CFObject -> ncdfCF::CFAxis -> CFAxisTime
Active bindings
friendlyClassName(read-only) A nice description of the class.
dimnames(read-only) The coordinates of the axis as a character
vector.
Methods
Public methods
-
-
-
-
-
-
-
-
-
Inherited methods
Method new()
Create a new instance of this class.
Usage
CFAxisTime$new(grp, nc_var, nc_dim, values)
Arguments
grpThe group that contains the netCDF variable.
nc_varThe netCDF variable that describes this instance.
nc_dimThe netCDF dimension that describes the dimensionality.
valuesThe CFTime instance that manages this axis.
Method print()
Summary of the time axis printed to the console.
Usage
CFAxisTime$print(...)
Arguments
...Arguments passed on to other functions. Of particular interest
is width = to indicate a maximum width of attribute columns.
Returns
self, invisibly.
Method brief()
Some details of the axis.
Usage
CFAxisTime$brief()
Returns
A 1-row data.frame with some details of the axis.
Method time()
Retrieve the CFTime instance that manages the values of
this axis.
Usage
CFAxisTime$time()
Returns
An instance of CFTime.
Method indexOf()
Retrieve the indices of supplied values on the time axis.
Usage
CFAxisTime$indexOf(x, method = "constant", rightmost.closed = FALSE)
Arguments
xA vector of timestamps whose indices into the time axis to
extract.
methodExtract index values without ("constant", the default) or
with ("linear") fractional parts.
rightmost.closedWhether or not to include the upper limit.
Default is FALSE.
Returns
An integer vector giving the indices in the time axis of valid
values in x, or integer(0) if none of the values are valid.
Method slice()
Retrieve the indices of the time axis falling between two
extreme values.
Usage
CFAxisTime$slice(x, rightmost.closed = FALSE)
Arguments
xA vector of two timestamps in between of which all indices into
the time axis to extract.
rightmost.closedWhether or not to include the upper limit.
Default is FALSE.
Returns
An integer vector giving the indices in the time axis between
values in x, or integer(0) if none of the values are valid.
Method subset()
Return an axis spanning a smaller coordinate range. This
method returns an axis which spans the range of indices given by the
rng argument.
Usage
CFAxisTime$subset(group, rng = NULL)
Arguments
groupThe group to create the new axis in.
rngThe range of values from this axis to include in the returned
axis.
Returns
A CFAxisTime instance covering the indicated range of indices.
If the rng argument includes only a single value, an CFAxisScalar
instance is returned with its value being the character timestamp of
the value in this axis. If the value of the argument is NULL, return
the entire axis (possibly as a scalar axis).
Method write()
Write the axis to a netCDF file, including its attributes.
If the calendar name is "gregorian", it will be set to the functionally
identical calendar "standard" as the former is deprecated.
Usage
CFAxisTime$write(nc = NULL)
Arguments
ncThe handle of the netCDF file opened for writing or a group in
the netCDF file. If NULL, write to the file or group where the axis
was read from (the file must have been opened for writing). If not
NULL, the handle to a netCDF file or a group therein.
Returns
Self, invisibly.
Method clone()
The objects of this class are cloneable with this method.
Usage
CFAxisTime$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
ncdfCF documentation built on April 16, 2025, 9:08 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| CFAxisTime | R Documentation |
Time axis object
Description
This class represents a time axis. The functionality is provided
by the CFTime class in the CFtime package.
Super classes
ncdfCF::CFObject -> ncdfCF::CFAxis -> CFAxisTime
Active bindings
friendlyClassName(read-only) A nice description of the class.
dimnames(read-only) The coordinates of the axis as a character vector.
Methods
Public methods
Inherited methods
Method new()
Create a new instance of this class.
Usage
CFAxisTime$new(grp, nc_var, nc_dim, values)
Arguments
grpThe group that contains the netCDF variable.
nc_varThe netCDF variable that describes this instance.
nc_dimThe netCDF dimension that describes the dimensionality.
valuesThe
CFTimeinstance that manages this axis.
Method print()
Summary of the time axis printed to the console.
Usage
CFAxisTime$print(...)
Arguments
...Arguments passed on to other functions. Of particular interest is
width = to indicate a maximum width of attribute columns.
Returns
self, invisibly.
Method brief()
Some details of the axis.
Usage
CFAxisTime$brief()
Returns
A 1-row data.frame with some details of the axis.
Method time()
Retrieve the CFTime instance that manages the values of
this axis.
Usage
CFAxisTime$time()
Returns
An instance of CFTime.
Method indexOf()
Retrieve the indices of supplied values on the time axis.
Usage
CFAxisTime$indexOf(x, method = "constant", rightmost.closed = FALSE)
Arguments
xA vector of timestamps whose indices into the time axis to extract.
methodExtract index values without ("constant", the default) or with ("linear") fractional parts.
rightmost.closedWhether or not to include the upper limit. Default is
FALSE.
Returns
An integer vector giving the indices in the time axis of valid
values in x, or integer(0) if none of the values are valid.
Method slice()
Retrieve the indices of the time axis falling between two extreme values.
Usage
CFAxisTime$slice(x, rightmost.closed = FALSE)
Arguments
xA vector of two timestamps in between of which all indices into the time axis to extract.
rightmost.closedWhether or not to include the upper limit. Default is
FALSE.
Returns
An integer vector giving the indices in the time axis between
values in x, or integer(0) if none of the values are valid.
Method subset()
Return an axis spanning a smaller coordinate range. This
method returns an axis which spans the range of indices given by the
rng argument.
Usage
CFAxisTime$subset(group, rng = NULL)
Arguments
groupThe group to create the new axis in.
rngThe range of values from this axis to include in the returned axis.
Returns
A CFAxisTime instance covering the indicated range of indices.
If the rng argument includes only a single value, an CFAxisScalar
instance is returned with its value being the character timestamp of
the value in this axis. If the value of the argument is NULL, return
the entire axis (possibly as a scalar axis).
Method write()
Write the axis to a netCDF file, including its attributes. If the calendar name is "gregorian", it will be set to the functionally identical calendar "standard" as the former is deprecated.
Usage
CFAxisTime$write(nc = NULL)
Arguments
ncThe handle of the netCDF file opened for writing or a group in the netCDF file. If
NULL, write to the file or group where the axis was read from (the file must have been opened for writing). If notNULL, the handle to a netCDF file or a group therein.
Returns
Self, invisibly.
Method clone()
The objects of this class are cloneable with this method.
Usage
CFAxisTime$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.