warming_stripes_plot: A 'cmsaf' extension for creating warming stripes plots.
In cmsafvis: Tools to Visualize CM SAF NetCDF Data

warming_stripes_plot

R Documentation

A 'cmsaf' extension for creating warming stripes plots.

Description

This plotting routine generates graphical output for the given variable within the given time range and area. Dependent on the output format a PNG is created.

Usage

warming_stripes_plot(
  variable = NULL,
  infile = NULL,
  selected_number = 1,
  color_pal = 1,
  analyze_method = TRUE,
  temp_dir = tempdir(),
  out_dir = getwd(),
  climate_dir = NULL,
  climate_year_start = 1983,
  climate_year_end = 2018,
  start_date = NULL,
  end_date = NULL,
  country_code = "S_A",
  lon_min = NULL,
  lon_max = NULL,
  lat_min = NULL,
  lat_max = NULL,
  outfile_name = NULL,
  output_format = "graphic",
  language = "eng",
  keep_files = TRUE,
  states = FALSE,
  attach = FALSE,
  infile_attach = "auto",
  pointsTF = FALSE,
  lineTF = FALSE,
  circ_plot = FALSE,
  title = "",
  verbose = TRUE,
  nc = NULL
)

Arguments

`variable`	Name of variable in infile (`NULL` or character). If `NULL` then the first variable from the infile is taken.
`infile`	Path to NetCDF file (`NULL` or character). If `NULL` then it needs to be specified in the config file.
`selected_number`	Timesteps of the same selected time range (Warming Stripes Plots, Time Series Plots, Trend Plots)
`color_pal`	Color option for stripe and anomaly plots
`analyze_method`	Two analyze methods: mean == FALSE; accumulate == TRUE (logical) (Warming Stripes Plots, Time Series Plots, Trend Plots)
`temp_dir`	Path to temporary working directory (character).
`out_dir`	Path to output directory (character).
`climate_dir`	Path to directory in which climatology is computed or contained (`NULL` or character). If `NULL` then the temp_dir directory is taken.
`climate_year_start`	Start year of climatology (integer).
`climate_year_end`	End year of climatology (integer).
`start_date`	Start date in format of 'YYYY-MM-DD' (`NULL` or character). If `NULL` then the first date of the infile is used.
`end_date`	End date in format of 'YYYY-MM-DD' (`NULL` or character). If `NULL` then the last date of the infile is used.
`country_code`	Either a country code in iso3c format or from the following: 'AFR' for Africa, 'EUR' for Europe, 'TOT' for the total disc, or 'S_A' for an arbitrary region selection (character). If a country is passed the data from within this country is extracted, else a rectangular box is visualized. Directly provided latitude and longitude ranges will be ignored in case of 'AFR', 'EUR' or 'TOT'.
`lon_min`	Longitude of lower left corner (`NULL` or numeric). If `NULL` then the smallest longitude of the infile is used.
`lon_max`	Longitude of upper right left corner (`NULL` or numeric). If `NULL` then the largest longitude of the infile is used.
`lat_min`	Latitude of lower left corner (`NULL` or numeric). If `NULL` then the smallest latitude of the infile is used.
`lat_max`	Latitude of upper right corner (`NULL` or numeric). If `NULL` then the largest latitude of the infile is used.
`outfile_name`	Filename of the PNG or MP4 outfile (`NULL` or character). If `NULL` then a name is computed from the current configuration. Please match the file ending according to the output_format.
`output_format`	Specification of output format (either 'graphic' for PNG or 'animation' for MP4).
`language`	Language used for title, legend, etc. in plots (either 'eng' for English or 'deu' for German).
`keep_files`	A flag indicating whether all files created in the process of obtaining the output file should be kept (logical). If false, all intermediate results are deleted, otherwise all are kept. Keeping these files could improve performance in further function calls.
`states`	Whether to crop/plot administration level of states (logical).
`attach`	Whether to temporaly merge the infile to an already existing one. (logical).
`infile_attach`	File to attach the infile to. When 'auto', a suitable file will be searched in out_dir. If attach is false, this will be ignored(character).
`pointsTF`	Show data points (logical).
`lineTF`	Show trend line (logical).
`circ_plot`	Circular stripe plots (logical)
`title`	Set title (character).
`verbose`	Whether to display progress messages (logical).
`nc`	Alternatively to `infile` you can specify the input as an object of class `ncdf4` (as returned from `ncdf4::nc_open`).