This class represents a time axis. The functionality is provided
by the CFTime class in the CFtime package.
ncdfCF::CFObject -> ncdfCF::CFAxis -> CFAxisTime
friendlyClassName(read-only) A nice description of the class.
dimnames(read-only) The coordinates of the axis as a character vector.
Inherited methods
ncdfCF::CFObject$add_coordinates()ncdfCF::CFObject$append_attribute()ncdfCF::CFObject$attribute()ncdfCF::CFObject$delete_attribute()ncdfCF::CFObject$print_attributes()ncdfCF::CFObject$set_attribute()ncdfCF::CFObject$write_attributes()ncdfCF::CFAxis$can_append()ncdfCF::CFAxis$peek()ncdfCF::CFAxis$shard()
new()Create a new instance of this class.
Creating a new time axis is more easily done with the makeTimeAxis()
function.
CFAxisTime$new(nc_var, nc_dim, values)nc_varThe netCDF variable that describes this instance.
nc_dimThe netCDF dimension that describes the dimensionality.
valuesThe CFTime instance that manages this axis.
...Arguments passed on to other functions. Of particular interest
is width = to indicate a maximum width of attribute columns.
self, invisibly.
brief()Some details of the axis.
CFAxisTime$brief()A 1-row data.frame with some details of the axis.
time()Retrieve the CFTime instance that manages the values of
this axis.
CFAxisTime$time()An instance of CFTime.
identical()Tests if the axis passed to this method is identical to
self.
CFAxisTime$identical(axis)axisThe CFAxisTime instance to test.
TRUE if the two axes are identical, FALSE if not.
append()Append a vector of time values at the end of the current values of the axis.
CFAxisTime$append(from)fromAn instance of CFAxisTime whose values to append to the
values of self.
A new CFAxisTime instance with values from self and the from
axis appended.
indexOf()Retrieve the indices of supplied values on the time axis.
CFAxisTime$indexOf(x, method = "constant", rightmost.closed = FALSE)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.
An integer vector giving the indices in the time axis of valid
values in x, or NA if the value is not valid.
slice()Retrieve the indices of the time axis falling between two extreme values.
CFAxisTime$slice(x, rightmost.closed = FALSE)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.
An integer vector giving the indices in the time axis between
values in x, or integer(0) if none of the values are valid.
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.
CFAxisTime$subset(group, rng = NULL)groupThe group to create the new axis in.
rngThe range of indices whose values from this axis to include in the returned axis.
A CFAxisTime instance covering the indicated range of indices.
If the value of the argument is NULL, return the entire axis.
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.
CFAxisTime$write(nc = NULL)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.
Self, invisibly.
clone()The objects of this class are cloneable with this method.
CFAxisTime$clone(deep = FALSE)deepWhether to make a deep clone.