render_plot_time_series_compare: Plotting routine designed for the CM SAF R Toolbox.

View source: R/render_plot_time_series_compare.R

render_plot_time_series_compareR Documentation

Plotting routine designed for the CM SAF R Toolbox.

Description

This function provides a time series comparison of two data sets.

Usage

render_plot_time_series_compare(
  outfile = NULL,
  fileExtension = ".png",
  visualizeVariables,
  ticknumber,
  dateformat,
  sliderx,
  slidery,
  checkGroup_type,
  imagewidth,
  imageheight,
  text1_1d,
  text2_1d,
  textsize,
  linesize,
  col,
  legend_label1,
  legend_label2,
  station_number
)

Arguments

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).

ticknumber

Number of ticks (numeric).

dateformat

Date format for constructing a date label.

sliderx

Limiting the time series with a two valued vector for min and max (numeric).

slidery

Limiting the y axis with a two valued vector for min and max (numeric).

checkGroup_type

An integer between 1 and 5 indicating group type (numeric). 1 for Line, 2 for Points, 3 for Line and Points, 4 for steps, 5 for histogram.

imagewidth

Width of the image (numeric).

imageheight

Height of the image (numeric).

text1_1d

Title text (character).

text2_1d

Text to be passed to graphics::mtext (character).

textsize

Textsize to be used (cex).

linesize

Line width to be used (positive numeric).

col

A color chosen via colourpicker::colourInput.

legend_label1

Legend label of the first data set

legend_label2

Legend label of the second data set

station_number

For station data compare; which station is selected


cmsafvis documentation built on Sept. 30, 2024, 5:07 p.m.