R/readNcdf.R

In ncdf.tools: Easier 'NetCDF' File Handling

readNcdf <- function(
  ##title<< Easy reading of netCDF data
  file.name ##<< character string: name of the netCDF file file to read the data from.
  ,var.name = c()  ##<< character string: name of the variable to extract. If not supplied,
            ## this is tried to be determined with readNcdfVarName().
)
  ##description<<
  ## Convenience function to automatically read in data from a netCDF file
  ## without specifying variable names and opening and closing file connections.
{
  file.con <- open.nc(file.name)
  if (length(var.name) == 0)
    var.name = readNcdfVarName(file.con)
  data     <- var.get.nc(file.con, var.name)
  close.nc(file.con)
  ##value<< (multidimensional) array: data from the netCDF file.
  return(data)
}