NcOpener: NetCDF file opener for 'startR'

In startR: Automatically Retrieve Multidimensional Distributed Data Sets

NetCDF file opener for 'startR'

Description

This is a file opener function for NetCDF files, intended for use as parameter 'file_opener' in a Start() call. This function complies with the input/output interface required by Start() defined in the documentation for the parameter 'file_opener'.

This function uses the function NcOpen() in the package 'easyNCDF', which in turn uses nc_open() in the package 'ncdf4'.

Usage

NcOpener(file_path)

Arguments

file_path

A character string indicating the path to the data file to read. See details in the documentation of the parameter 'file_opener' of the function Start().

Value

An open connection to a NetCDF file with additional header information as returned by nc_open() in the package 'ncdf4'. See details in the documentation of the parameter 'file_opener' of the function Start().

See Also

NcDimReader NcDataReader NcCloser NcVarReader

Examples

data_path <- system.file('extdata', package = 'startR')
path_obs <- file.path(data_path, 'obs/monthly_mean/tos/tos_200011.nc')
connection <- NcOpener(path_obs)
NcCloser(connection)

startR documentation built on Sept. 12, 2023, 5:07 p.m.