readNcdfDataframe: readNcdfDataframe

In bgctw/ncdfTools: Handling NetCDF Files

Description

fast reading of a single point netCDF file into an data.frame

Usage

readNcdfDataframe(file.name, varPattern = vars, 
    dimVar = "time", isConvertTime = (dimVar == 
        "time"), tzone = "UTC", dimRange = NULL, 
    isAttachingUnit = TRUE, vars = character())

Arguments

file.name	character string: name of the ncdf file to read the data from.
varPattern	string vector of regular expression patterns of variable names to extract, that are concatenated by OR. Default empty corresponds to all variables.
dimVar	scalar string: name of the single dimension
isConvertTime	if true, the dimension is read by readNcdfTime
tzone	timezone formatting applied to the time dimension.
dimRange	possibility to specify start and end of the single dimension to read only a subset. Values must exactly match entries in dimVar
isAttachingUnit	set to FALSE to not try reading unit
vars	alternative shorthand for varPattern

Details

Convenience function to automatically read in data from a ncdf file without specifying variable names and opening file connections.

Expects all variables in the file to be one-dimensional.

Value

data.frame of all variables in the file. First column is the dimension, usually time.

Author(s)

Jannis v. Buttlar, Thomas Wutzler

See Also

updateNcdfDataframe

bgctw/ncdfTools documentation built on Jan. 29, 2020, 1:16 p.m.