RNetCDF (version 2.4-2)

dim.rename.nc: Rename a NetCDF Dimension

Description

Rename a NetCDF dimension.

Usage

dim.rename.nc(ncfile, dimension, newname)

Arguments

ncfile

Object of class "NetCDF" which points to the NetCDF dataset (as returned from open.nc).

dimension

Either the ID or the name of the dimension to be renamed.

newname

The new dimension name.

Details

This function renames an existing dimension in a NetCDF dataset open for writing. A dimension cannot be renamed to have the same name as another dimension.

References

https://www.unidata.ucar.edu/software/netcdf/

Examples

# NOT RUN {
##  Create a new NetCDF dataset and define two dimensions
file1 <- tempfile("dim.rename_", fileext=".nc")
nc <- create.nc(file1)

dim.def.nc(nc, "station", 5)
dim.def.nc(nc, "time", unlim=TRUE)

##  Rename the dimensions
dim.rename.nc(nc, 0, "mystation")
dim.rename.nc(nc, "time", "mytime")

close.nc(nc)
unlink(file1)
# }