att.get.nc: Get a NetCDF Attribute

Description Usage Arguments Details Value Note Author(s) References Examples

View source: R/RNetCDF.R

Description

Get an attribute from a NetCDF dataset.

Usage

1
att.get.nc(ncfile, variable, attribute)

Arguments

ncfile

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

variable

ID or name of the variable from which the attribute will be read, or "NC_GLOBAL" for a global attribute.

attribute

Attribute name or ID.

Details

This function returns the value of the attribute.

Value

A vector of type character if the on-disk type is NC_CHAR, otherwise numeric. No distinction is made between the different storage types of numeric objects.

Note

NC_BYTE is always interpreted as signed.

Author(s)

Pavel Michna

References

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
##  Create a new NetCDF dataset and define two dimensions
nc <- create.nc("att.get.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()))

##  Get these attributes
att.get.nc(nc, "temperature", "missing_value")
att.get.nc(nc, "temperature", "long_name")
att.get.nc(nc, "NC_GLOBAL", "title")
att.get.nc(nc, "NC_GLOBAL", "history")

close.nc(nc)

RNetCDF documentation built on May 2, 2019, 6:12 p.m.