cmsaf.diff: Plotting routine designed for the CM SAF R Toolbox.

View source: R/cmsaf.diff.R

cmsaf.diffR Documentation

Plotting routine designed for the CM SAF R Toolbox.

Description

This function renders a difference plot (absolute or relative) of two variables.

Usage

cmsaf.diff(
  var1,
  infile1,
  var2,
  infile2,
  outfile,
  plot.out = FALSE,
  relative = FALSE,
  nc34 = 4,
  overwrite = FALSE,
  verbose = FALSE,
  toolbox = FALSE,
  nc1 = NULL,
  nc2 = NULL
)

Arguments

var1

Name of the first NetCDF variable (character).

infile1

Filename of the first input NetCDF file. This may include the directory (character).

var2

Name of the second NetCDF variable (character).

infile2

Filename of the second input NetCDF file. This may include the directory (character).

outfile

Filename of output NetCDF file. This may include the directory (character).

plot.out

logical; if TRUE, the plot will be stored in the same folder as outfile. If FALSE, the plot will not be saved.

relative

logical; if TRUE, plot a relative difference plot

nc34

NetCDF version of output file. If nc34 = 3 the output file will be in NetCDFv3 format (numeric). Default output is NetCDFv4.

overwrite

logical; should existing output file be overwritten?

verbose

logical; if TRUE, progress messages are shown

toolbox

logical; if TRUE, toolbox mode enabled. The two files are adjusted in space and time so that they can be plotted.

nc1

Alternatively to infile1 you can specify the input as an object of class ncdf4 (as returned from ncdf4::nc_open).

nc2

Alternatively to infile2 you can specify the input as an object of class ncdf4 (as returned from ncdf4::nc_open).

Value

A NetCDF file is written.

See Also

Other 2d visualization: cmsaf.side.by.side()


cmsafvis documentation built on March 18, 2022, 6:23 p.m.