oceanmap (version 0.1.0)

parameter_definitions: parameter definitions dataframe

Description

a dataframe containing definitions of parameters to plot or to save by v, readbin and writebin.

Usage

data(parameter_definitions)

Value

a dataframe with the following header, containing definitions of parameters to plot or to save by v, readbin and writebin:

param a b c log name1 unit pal1 minv maxv min max invalid_data_dc coast_dc land_dc no_data_dc

param

character string indicating the keyword of a parameter.

a,b,c

value for parameter parameter data conversion from/to byte data. (See param_convert and param_unconvert)

log

whether a logarithmic formula should be applied for data conversion (0 for FALSE and 1 for TRUE; See param_convert and param_unconvert).

name

character string indicating the long name of a parameter.

unit

character string or bgroup statement indicating the parameter unit.

pal1

default color map used by v calls on parameter related data.

minv, maxv

default minimum and maximum z-value used by v calls on parameter related data.

min, max

minimum and maximum byte-values to be considered when calculating absolute values.

invalid_data_dc, coast_dc, land_dc & no_data_dc

byte values used to mask invalid data, coast lines, land masses and missing data.

Format

data.frame

See Also

v

Examples

# NOT RUN {
## Example
data(parameter_definitions)
head(parameter_definitions)

# selecting sea surface temperature parameter definition
parameter_definitions[parameter_definitions$param == "sst2",] 
# }