file.inq.nc: Inquire About a NetCDF Dataset

In RNetCDF: Interface to 'NetCDF' Datasets

Inquire About a NetCDF Dataset

Description

Inquire about a NetCDF dataset.

Usage

file.inq.nc(ncfile)

Arguments

ncfile

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

Value

A list containing the following components:

ndims	Number of dimensions defined for this NetCDF dataset.
nvars	Number of variables defined for this NetCDF dataset.
ngatts	Number of global attributes for this NetCDF dataset.
unlimdimid	ID of the unlimited dimension, if there is one for this NetCDF dataset. Otherwise NA will be returned.
format	Format of file, typically "classic", "offset64", "data64", "classic4" or "netcdf4".
libvers	Version string of the NetCDF library in the current R session.

Author(s)

Pavel Michna, Milton Woods

References

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

Examples

##  Create a new NetCDF dataset and define two dimensions
file1 <- tempfile("file.inq_", fileext=".nc")
nc <- create.nc(file1)

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

##  Create two variables, one as coordinate variable
var.def.nc(nc, "time", "NC_INT", "time")
var.def.nc(nc, "temperature", "NC_DOUBLE", c(0,1))

##  Put some attributes
att.put.nc(nc, "temperature", "_FillValue", "NC_DOUBLE", -99999.9)
att.put.nc(nc, "temperature", "long_name", "NC_CHAR", "air temperature")
att.put.nc(nc, "NC_GLOBAL", "title", "NC_CHAR", "Data from Foo")
att.put.nc(nc, "NC_GLOBAL", "history", "NC_CHAR", paste("Created on", date()))

##  Inquire about the dataset
file.inq.nc(nc)

close.nc(nc)
unlink(file1)

RNetCDF documentation built on May 29, 2024, 2:41 a.m.