Package index • datamatch

Fetching data

Seven sources behind one interface, sharing one set of variable names, and all returning the same shape. A value of the same name from two of them is not the same number - each function’s help says what its source is and is not good for.

accessCopernicus(): Access environmental data from Copernicus Marine Service
accessEnvDat(): Fetch Copernicus data (deprecated name)
accessFVCOM(): Access FVCOM output from the NECOFS hindcast
accessHYCOM(): Access HYCOM output from the GOFS 3.1 reanalysis
accessCEFI(): Access CEFI regional MOM6 output
accessCCMP(): Access CCMP ocean surface winds
accessERDDAP(): Access satellite data through ERDDAP
accessOBDAAC(): Access NASA OB.DAAC ocean colour and sea surface temperature
fill_satellite_gaps(): Fill satellite gaps with the model equivalent
forecast_variables(): Forecast equivalents of the catalog variables

Matching

The spatiotemporal nearest-feature join, the columns it adds, and where each value came from.

matchData(): Match one set of points to another in space and time
covariate_columns(): Covariate column names in an environmental data object
source_of(): Which source and archive produced a fetched object
write_eml(): Write EML metadata for a matched table

Resampling

Moving between grids and time steps. Aggregating loses detail, which is the safe direction; interpolating adds cells, not information.

upscale_grid(): Aggregate environmental data onto a coarser grid
downscale_grid(): Interpolate environmental data onto a finer grid
upscale_time(): Aggregate environmental data onto a coarser time step
downscale_time(): Interpolate environmental data onto a finer time step
grid_resolution(): Grid resolution of an environmental data object

Seafloor terrain

Depth, slope, aspect, and TPI from NOAA ETOPO.

fetch_bathymetry(): Fetch static bathymetry for a study area
attach_bathymetry(): Attach static bathymetry to a table of points
bathymetry_variables(): Static seafloor variables

Climate indices

Basin-scale indices, their units, and the cache that expires on each provider’s publishing cadence.

fetch_climate_index(): Fetch a monthly climate index
attach_climate_index(): Attach climate indices to observations
climate_indices(): Catalog of basin-scale climate indices
index_dictionary() print(<datamatch_index_dictionary>): Printable dictionary of climate indices
climate_index_status() print(<datamatch_index_status>): What is cached, how old it is, and whether it is due a refresh
refresh_climate_index(): Re-download cached climate indices

Plotting

Base-graphics views of what was downloaded and what it matched to. Each returns the data it drew.

plot_env(): Map an environmental variable
plot_coverage(): Plot how much data each time step actually has
plot_series(): Plot a variable through time
plot_matched(): Plot observations coloured by a matched covariate
plot_mesh(): Map covariates on an unstructured mesh, or anywhere else

Catalogs and lookup

What each source offers, which dataset or archive a variable comes from, and where it is documented.

variable_dictionary() print(<datamatch_dictionary>): Printable dictionary of variable names
variable_dataset(): Look up the dataset a set of variables comes from
copernicus_variables(): Catalog of Copernicus variables under familiar names
fvcom_variables(): Catalog of FVCOM variables under the same names as the Copernicus ones
fvcom_dictionary(): Printable dictionary of FVCOM variables
fvcom_archives(): FVCOM archives this package ships with
fvcom_archive(): Describe any FVCOM archive, so it can be read like a built-in one
fvcom_mesh(): Read an FVCOM mesh on its own, with no data on it
hycom_variables(): Catalog of HYCOM variables under the same names as the Copernicus ones
hycom_dictionary(): Printable dictionary of HYCOM variables
hycom_archives(): HYCOM archives this package can read
hycom_covering(): Which HYCOM archives cover a given date
cefi_variables(): Catalog of CEFI variables under familiar names
cefi_dictionary(): Printable dictionary of CEFI variables
cefi_archives(): The CEFI regional MOM6 runs this package ships with
cefi_archive(): Describe any CEFI directory, so it can be read like a built-in one
ccmp_variables(): Catalog of CCMP wind variables
ccmp_dictionary(): Printable dictionary of CCMP variables
ccmp_versions(): CCMP versions this package can read
erddap_datasets(): Satellite datasets read through ERDDAP
erddap_dataset(): Describe any ERDDAP griddap dataset, so it can be read like a built-in one
erddap_dictionary(): Printable dictionary of the ERDDAP datasets and their variables
obdaac_variables(): Catalog of OB.DAAC variables under familiar names
obdaac_dictionary(): Printable dictionary of OB.DAAC variables
obdaac_sensors(): Ocean colour sensors read through NASA OB.DAAC
product_url(): Copernicus Marine product page for a product identifier
as_markdown(): Render a dictionary as a markdown table