README.md

In pacificclimate/ncdf4.helpers: Helper Functions for Use with the 'ncdf4' Package

ncdf4.helpers

ncdf4.helpers is a collection of helpful R functions for working with netCDF files that conform to the CF Conventions. The CF Conventions define metadata needed to specify the spatial and temporal properties of a dataset and a description of what each variable represents. This library can be used in addition to ncdf4 to work with netCDF files that follow this standard.

Using ncdf4.helpers

You can install ncdf4.helpers from CRAN within R:

install.packages("ncdf4.helpers")
library("ncdf4.helpers")

Help on the package or individual functions is available within R:

?ncdf4.helpers
?nc.get.time.series

Updating ncdf4.helpers

Eventually much of this will be automated, but for now:

1. Update the version in DESCRIPTION and describe changes in CHANGELOG
2. Regenerate the documentation by running roxygen::roxygenize("/path/to/ncdf4.helpers") with R
3. Add the following two lines to the NAMESPACE file generated by roxygen:

importFrom("stats", "na.omit")
importFrom("utils", "head", "tail")

1. Commit changes to github
2. If the github tests pass, you can build the new package with R CMD build ncdf4.helpers and upload to CRAN if relevant.

pacificclimate/ncdf4.helpers documentation built on March 29, 2025, 4:12 a.m.