Skip to contents

Get variable dimensions from a netCDF file

Source: R/nctools-auxiliar.R
ncvar_dim.Rd

Returns the dimensions associated with one variable, or with all variables in an open netCDF file.

Usage

ncvar_dim(nc, varid = NULL, value = FALSE)

Arguments

nc

An open netCDF connection created with [ncdf4::nc_open()].

varid

Variable identifier. This can be a character string giving the variable name, or an object of class `ncvar4`. If `NULL`, dimensions are returned for all variables in the file.

value

Logical. If `TRUE`, return the coordinate values of each dimension instead of only the dimension names.

Value

If `varid` is `NULL`, a named list with one element per variable. If `varid` is supplied, the dimensions of the selected variable only. When `value = FALSE`, dimensions are returned as character vectors of dimension names. When `value = TRUE`, dimensions are returned as named lists of coordinate values.

See also

[ncvar_size()], [ncdim_size()], [ncdf4::nc_open()]

Examples

if (FALSE) { # \dontrun{
nc <- ncdf4::nc_open("input.nc")
on.exit(ncdf4::nc_close(nc))

ncvar_dim(nc)
ncvar_dim(nc, varid = "temp")
ncvar_dim(nc, varid = "temp", value = TRUE)
} # }