file_parameter_definitions: Make a parameter definition list for a file format

In andrew-MET/harpIO: IO functions and data wrangling for harp

Make a parameter definition list for a file format

Description

These functions are to be used together with add_param_def and modify_param_def to add a parameter definition entry for a particular file format.

Usage

new_grib_param(name, level_type = get("grib_level_types"), level = NULL)

new_netcdf_param(name, suffix = get("nc_level_suffixes"))

new_fa_param(name, units, name_len = 16)

new_v_param(name, harp_param, units, type = c("SYNOP", "TEMP"))

new_obsoul_param(name, harp_param, units)

Arguments

name	The name of the parameter in the file. In the case of grib files, this should be the grib shortName and in the case of obsoul files, should be the number used to define what the variable is. In addition, can be expressed as a character vector for grib files in order to try different shortNames until the paramatet is found. Should be a named list if a function is to be applied with the names matching the argument names in the function.
level_type	The grib levelType. Can be a character vector in order to try different levelTypes until the variable is found in the file. The default is a named list using the in built grib_level_types to define the names for diffferent vertical coordinate systems.
level	The level number. Set to -999 for all levels.
suffix	The suffix to add to name for different vertical coordinate systems.
units	The units of the parameter in vfld / vobs files.
name_len	The number of characters that name should have in the FA files. This is 16 by default and adds blank spaces to the end of name to make it the required length.
harp_param	The name of the parameter to be used in outputs from read functions.
type	The type of the parmater - either "SYNOP" or "TEMP"

andrew-MET/harpIO documentation built on March 7, 2024, 7:48 p.m.