get.climdex.variable.metadata: Returns metadata for specified Climdex variables

In ECA-D/ecad_indices_grid: Functions to compute CLIMIND indices over a NetCDF grid

Returns metadata for specified Climdex variables

Description

Returns metadata for specified Climdex variables.

Usage

get.climdex.variable.metadata(vars.list, template.filename, metadata.config)

Arguments

vars.list	The list of variables, as returned by get.climdex.variable.list.
template.filename	The filename template to be used when generating filenames.
metadata.config	config object read using read_json_metadata_config_file. This contains all the metadata such as the output long names of the indices in the output NCDF files.

Details

This function returns metadata suitable for use in NetCDF files for the specified variables.

Value

A data frame containing the following:

• long.nameLong names for the variable

• var.nameVariable name for use in the file

• unitsUnits for the variable

• time.resThe time resolution of the variable.

• base.period.attrWhether to include a base period attribute

• standard.nameStandard name to use for the variable

• filenameFilename to be written out

Examples

## Get metadata (including filenames) for specified variables.
fn <- "pr_day_BCCAQ+ANUSPLIN300+MRI-CGCM3_historical+rcp85_r1i1p1_19500101-21001231.nc"
var.list2 <- get.climdex.variable.list("prec", time.resolution="annual")
md <- get.climdex.variable.metadata(var.list2, fn)

ECA-D/ecad_indices_grid documentation built on Nov. 23, 2022, 6:04 a.m.