DataFileInfo: DataFileInfo

DataFileInfoR Documentation

DataFileInfo

Description

Brief information on the contents of a netCDF data file

Usage

DataFileInfo(fileLocation = setFileName(), LLrange = TRUE)

Arguments

fileLocation

A complete address to the netCDF data file.

LLrange

Logical, if TRUE, range in latitude and longitude for the flight is included in the returned list. Set FALSE to get a faster return in case the range in positions is not needed.

Details

Reads the flight number, project, date/time, position, and variables from the netCDF file and returns a list of properties. Alternately, produces similar information for a saved (.Rdata-format) data.frame produced by reading such a netCDF file. In addition, produces a list of the long_names associated with the variables and a list of the "measurands" along with the redundant variables representing that measurand.

Value

A list containing named characteristics of the file. For example, in the example below the variables in the file are returned in FI$Variables. See names(FI) for a list of characteristics that are returned.

Author(s)

William Cooper

Examples

FI <-DataFileInfo (sprintf ("%s/extdata/RAFdata.nc", path.package ("Ranadu")))

NCAR/Ranadu documentation built on Jan. 27, 2023, 1:09 a.m.