R: Inquire About a NetCDF Dataset

file.inq.nc {RNetCDF} | R Documentation

## 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`).

### Details

This function returns values for the number of dimensions, the number of variables, the number of global attributes, and the dimension ID of the dimension defined with unlimited length, if any.

### 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.

### Author(s)

Pavel Michna

### References

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

### Examples

    ##  Create a new NetCDF dataset and define two dimensions
    nc <- create.nc("file.inq.nc")

    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", "missing_value", "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)

[Package RNetCDF version 1.9-1 Index]