dimnames: Names or dimension values of an CF object

In ncdfCF: Easy Access to NetCDF Files with CF Metadata Conventions

Names or dimension values of an CF object

Description

Retrieve the variable or dimension names of an ncdfCF object. The names() function gives the names of the variables in the data set, prepended with the path to the group if the resource uses groups. The return value of the dimnames() function differs depending on the type of object:

• CFDataset, CFVariable: The dimnames are returned as a vector of the names of the axes of the data set or variable, prepended with the path to the group if the resource uses groups. Note that this differs markedly from the base::dimnames() functionality.

• CFAxisNumeric, CFAxisLongitude, CFAxisLatitude, CFAxisVertical: The values of the elements along the axis as a numeric vector.

• CFAxisTime: The values of the elements along the axis as a character vector containing timestamps in ISO8601 format. This could be dates or date-times if time information is available in the axis.

• CFAxisScalar: The value of the scalar.

• CFAxisCharacter: The values of the elements along the axis as a character vector.

• CFAxisDiscrete: The index values of the axis, from 1 to the length of the axis.

Usage

## S3 method for class 'CFDataset'
names(x)

groups(x)

## S3 method for class 'CFDataset'
groups(x)

Arguments

x	An CFObject whose axis names to retrieve. This could be CFDataset, CFVariable, or a class descending from CFAxis.

Value

A vector as described in the Description section.

Examples

fn <- system.file("extdata",
  "pr_day_EC-Earth3-CC_ssp245_r1i1p1f1_gr_20230101-20231231_vncdfCF.nc",
  package = "ncdfCF")
ds <- open_ncdf(fn)

# CFDataset
dimnames(ds)

# CFVariable
pr <- ds[["pr"]]
dimnames(pr)

# CFAxisNumeric
lon <- ds[["lon"]]
dimnames(lon)

# CFAxisTime
t <- ds[["time"]]
dimnames(t)

ncdfCF documentation built on April 16, 2025, 9:08 a.m.