render_plot_side_by_side: Plotting routine designed for the CM SAF R Toolbox.
In cmsafvis: Tools to Visualize CM SAF NetCDF Data

View source: R/render_plot_side_by_side.R

render_plot_side_by_side

R Documentation

Plotting routine designed for the CM SAF R Toolbox.

Description

This function renders a 2D image of two files usually called by the CM SAF R Toolbox.

Usage

render_plot_side_by_side(
  plot_rinstat,
  outfile = NULL,
  fileExtension = ".png",
  visualizeVariables,
  visualizeDataTimestep,
  nc_path_visualize,
  visualizeDataMax,
  timestep_2d,
  lon_bounds,
  lat_bounds,
  lon_loc_vec,
  lat_loc_vec,
  name_loc_vec,
  timestep,
  num_tick,
  num_rmin,
  num_rmax,
  num_brk,
  co.data,
  proj,
  xort,
  yort,
  rort,
  slider1,
  slider2,
  imagewidth,
  imageheight,
  location,
  int,
  text1,
  text2,
  text3,
  textsize,
  bordercolor,
  linesize,
  na.color,
  PAL,
  palettes,
  reverse,
  plot_grid,
  grid_col,
  text1_2,
  text2_2
)

Arguments

`plot_rinstat`	Whether to create an R-Instat plot (logical).
`outfile`	Name of the outfile (NULL or character). Should match the fileExtension. If NULL is passed a file is created in the R session temporary directory.
`fileExtension`	The file extension of the image (character). Has to be one of the following: 'png', 'jpg', 'tif', 'kml', 'pdf'.
`visualizeVariables`	A data frame containing all meta data for the plotting process (data.frame).
`visualizeDataTimestep`	The data to be plotted.
`nc_path_visualize`	The nc file path of which the plot is generated for.
`visualizeDataMax`	Maximal data for computing breaks.
`timestep_2d`	The time step to be visualized.
`lon_bounds`	Array containing two values for longitude min and max (numeric).
`lat_bounds`	Array containing two values for latitude min and max (numeric).
`lon_loc_vec`	All longitude entries for points at (lat_loc_vec, lon_loc_vec) to be specified on the map (numeric).
`lat_loc_vec`	All latitude entries for points at (lat_loc_vec, lon_loc_vec) to be specified on the map (numeric).
`name_loc_vec`	Names for the points at (lat_loc_vec, lon_loc_vec) to be specified on the map (numeric).
`timestep`	The current timestep chosen.
`num_tick`	Number of ticks (numeric).
`num_rmin`	Color scale range minimum (numeric).
`num_rmax`	Color scale range maximium (numeric).
`num_brk`	Number of breaks (numeric).
`co.data`	Data to be plotted in R-Instat mode (data.frame).
`proj`	The chosen projection (either 'rect' for rectangular or 'ortho' for orthographic).
`xort`	Centering the globe at longitude xort (numeric). Only in orthographic mode.
`yort`	Centering the globe at latitude yort (numeric). Only in orthographic mode.
`rort`	Rotation of the globe (numeric). Only in orthographic mode.
`slider1`	Controlling the horizontal plot position as vector of two values min and max (numeric).
`slider2`	Controlling the vertical plot position as vector of two values min and max (numeric).
`imagewidth`	Width of the image (numeric).
`imageheight`	Height of the image (numeric).
`location`	Whether points specified by (lat_loc_vec, lon_loc_vec, name_loc_vec) should be added to the map (logical).
`int`	Whether interior country borders should be added (logical).
`text1`	Title text data set 1 (character).
`text2`	Text to be passed to graphics::mtext for data set 1 (character).
`text3`	Text to be added to the legend (character).
`textsize`	Textsize to be used (cex).
`bordercolor`	Color used for borders.
`linesize`	Line width to be used (positive numeric).
`na.color`	The color to be used for NA values.
`PAL`	Color palette.
`palettes`	Color palettes to be used.
`reverse`	Whether to revert the color palette (logical).
`plot_grid`	Whether to plot a grid using color grid_col (logical).
`grid_col`	Color used for the grid.
`text1_2`	Title text data set 2 (character).
`text2_2`	Text to be passed to graphics::mtext for data set 2 (character).