This is a dimension reader function for NetCDF files, intended for use as parameter file_dim_reader
in a call to the function Start()
in the package 'startR'. This function complies with the input/output interface required by Start()
defined in the documentation for the parameter file_dim_reader
of that function.
This function uses the function NcReadDims()
in the package 'easyNCDF'.
NcDimReader(file_path = NULL, file_object = NULL, file_selectors = NULL,
inner_indices = NULL, synonims)
Character string with the path to the data file to read the dimensions for. See details in the documentation of the parameter file_dim_reader
of the function Start()
.
Open connection to a NetCDF file, optionally with additional header information. See details in the documentation of the parameter file_dim_reader
of the function Start()
.
Information on the path of the file to read data from. See details in the documentation of the parameter file_dim_reader
of the function Start()
.
Named list with the numeric indices to take from each of the inner dimensions in the requested file. Used only in advanced configurations. See details in the documentation of the parameter file_dim_reader
of the function Start()
.
Named list with synonims for the dimension names to look for in the requested file, exactly as provided in the parameter synonims
in a call to the function Start()
. See details in the documentation of the parameter file_dim_reader
of the function Start()
.
Named numeric vector with the names and sizes of the dimensions of the requested file.
# NOT RUN {
## Check https://earth.bsc.es/gitlab/es/startR for step-by-step examples
## of Start() that use NcDimReader().
# }
Run the code above in your browser using DataLab