plot_doc: plot docu

In Climandes/ClimIndVis: Calculation, verification and visualisation of climate indices

Description

plot docu

Arguments

obs	Observations. "climindvis" object of type p/grid as output from make_object by using daily observational or Re-analysis data.
hc	Hindcasts. "climindvis_index" object of type hc_p/hc_grid as output from make_object using an ensemble of daily seasonal hindcasts.
fc	Forecasts. "climindvis_index" object of type fc_p/fc_grid as output from make_object using an ensemble daily seasonal forecasts.
dat_p	Climindvis-object with type = "p" generated by make_object.
dat_grid	Climindvis-object with type = "grid" generated by make_object.
hc_p	Hindcasts at stations. Climindvis-object with type = "hc_p" generated by make_object.
hc_grid	Gridded hindcasts. Climindvis-object with type = "hc_grid" generated by make_object.
hc_ref_p	Optional. Reference hindcasts at stations for calculation of skill scores. If not provided (NULL), climatology is taken as reference. Default = NULL.
hc_ref_grid	Optional. Reference gridded hindcasts for calculation of skill scores. If not provided (NULL), climatology is taken as reference. Default = NULL.
fc_p	Forecasts at stations. Climindvis-object with type = "fc_p" generated by make_object.
fc_grid	Gridded forecasts. Climindvis-object with type = "fc_grid" generated by make_object.
obs_p	Station observations. Climindvis-object with type = "p" generated by make_object. For autoplot_forecast_map and autoplot_forecast_point only needed if skill criterion is applied.
obs_grid	Gridded observation data. Climindvis-object with type = "grid" generated by make_object. For autoplot_forecast_map and autoplot_forecast_point only needed if skill criterion is applied.
datlist_p	Single object or list of climindvis-objects with type = "p"/"hc_p" generated by make_object.
index	Name of index to be calculated., e.g. index = "dd" or index = "tnn". For list of indices see indices_list
index_args	List of arguments for index. See indices_list.
indices	Character array of indices to be calculated.
indices_args	List containing a list of index arguments for each index. See calc_index.
selyears	Integer array of years to be selected from data. For indices with quantiles, years as defined in index_args are used for quantile calculation, but only selected years are plotted. For functions using seasonal forecast data, selyears is only applied to hindcasts.
selpoints	Array to select subset of points to plot. There are two options: Character array of station names (works only if names are defined in climindvis_index objects ...$data_info$pnames and if they are the same for all objects in climindvis_index_list) Integer array of station indices (works only if coordinates of all objects in climindvis_index_list are the same)
trendplots	Logical. Plot trend line and 95% confidence interval for index. Default = FALSE.
NAmaxClim	Integer [0,100]. Maximum percentage of years with missing values for calculation of climatology. If exceeded value for respective grid point/station is set to NA. Default = 20 ( = 20"%").
NAmaxTrend	Integer [0,100]. Maximum percentage of years with missing values for calculation of trend. If exceeded value for respective grid point/station is set to NA. Default = 20 ( = 20"%").
text_noskill	Character string. Text to show if forecast skill is lower than noskill. Default = "no skill".
text_novar	Character string. Text if climatology shows no or little variation and plotting of forecast does not make sense. Default = "no or little variation in climatology".
text_nocat	Character string. Text if forecast shows no dominant forecast category (=probabilities of two or more cateogries are equal). Default = "no dominant category".
veri_metrics	Character array of skill metrics to calculate. For metrics see verify_index.
veri_args	Optional list of additional arguments for verification, see veri_args
ncat	Number of forecast categories. Default = 3.
plot_climatology	Logical. Should climatology of index be plottet as time series? If TRUE, time series with shading indicating corresponding climatological values for forecast categories are plottet. Default = FALSE.
tacholabs	Labels for categories of the tacho plot.
output	Format of image to be plotted ("png", "jpeg", "tiff", "pdf","dev.new"). Default = NULL, output to null device (getOption("device") will show you the null device. If you are not using RStudio, NULL and dev.new will give the same output).
plotdir	Character string of path of directory for saving plots. Ignored if output is NULL or "dev.new".
plot_title	Logical. Add plot title to graphic. Default = TRUE.
plotname	Optional. Character string. First part of plot name followed by character string containing index name/aggregation/time period/... depending on the autoplot function. Default = "".
graphic_device	Optional arguments for graphics devices (in addition to filename, width and height ), depending on the output chosen see png or pdf. Ignored if output is NULL or "dev.new".
title	Optional. Character string. If provided added above the plot in addition to default information from the respective function (e.g. index name/aggregation/time period/...). Default = "", no additional title is written.
plot_args	Optional. List of arguments passed to plotting function, see plot_args_map.

Climandes/ClimIndVis documentation built on Oct. 24, 2021, 10:52 a.m.