open_ncdf: Open a netCDF resource

In ncdfCF: Easy Access to NetCDF Files with CF Metadata Conventions

Open a netCDF resource

Description

This function will read the metadata of a netCDF resource and interpret the netCDF dimensions, variables and attributes to generate the corresponding CF objects. The data for the CF variables is not read, please see CFVariable for methods to read the variable data.

Usage

open_ncdf(resource, keep_open = FALSE)

Arguments

resource

The name of the netCDF resource to open, either a local file name or a remote URI.

keep_open

Logical flag to indicate if the netCDF resource has to remain open after reading the metadata. This should be enabled typically only for programmatic access or when a remote resource has an expensive access protocol (i.e. 2FA). The resource has to be explicitly closed with close() after use. Note that when a data set is opened with keep_open = TRUE the resource may still be closed by the operating system or the remote server.

Value

An CFDataset instance, or an error if the resource was not found or errored upon reading.

Examples

fn <- system.file("extdata",
  "pr_day_EC-Earth3-CC_ssp245_r1i1p1f1_gr_20230101-20231231_vncdfCF.nc",
  package = "ncdfCF")
(ds <- open_ncdf(fn))

ncdfCF documentation built on April 16, 2025, 9:08 a.m.