A named 2D array with dimensions 'cat_dim' × 'panel_dim', containing probabilities for each category (in relative units, summing to 1). Can also be a named vector (recycled to 2D internally).

A named 2D array with category threshold values (e.g., tercile cutoffs), or a vector with length one less than the category dimension of 'probs'. Should match the shape and names of 'probs'.

(optional) A 2D array (or vector) with probabilities for extreme categories (e.g., below P10, above P90), with dimensions matching 'probs'.

(optional) A 2D array (or vector) with limits corresponding to the extreme categories.

(optional) A numeric vector indicating skill scores for each panel. Used to reduce bar transparency if negative.

A character string with the main plot title.

A string with the title of the legend that shows the categories.

A string indicating the name of the category dimension. Default is "cat".

A string indicating the name of the panel dimension (e.g., time). Default is "ftime".

A string selecting the color palette to use. One of "s2s4e", "ggplot", "hydro", "vitigeoss". Default is "s2s4e".

A character vector with names for each forecast category. Default is c("bn", "norn", "an").

A string or vector of strings with titles for each panel. If one value, it is repeated across panels.

A string or vector with subtitles for each panel. If one value, it is repeated across panels.

A string or vector for the bottom axis label of each panel.

A numeric value indicating the vertical position of threshold annotations. Default is -1.5.

A numeric value (in cm) for the width of the legend area. Default is 3.

A numeric value between 0 and 1 defining the width of the bars for extreme categories. Default is 0.4.

A string for the shared x-axis title.

A character vector with names for the extreme categories (left and right). Default is c("p10", "p90").

A numeric value for the font size of the top title. Default is 16.

A string for justification of the title. One of "left", "center", "right". Default is "center".

(optional) Path to save the resulting plot (e.g., "plot.png"). If NULL, the plot is returned.

(optional) Width of the output figure, passed to ggsave(). Units are defined by 'size_units'.

(optional) Height of the output figure, passed to ggsave(). Units are defined by 'size_units'.

Units for width and height. Default is inches. See ggsave().

Plot resolution in dpi when saving to file. Default is NULL.

A character string of palette. The current choices:

• 'bluered': from blue through white to red.

• 'redblue': from red through white to blue.

• 'yellowred': from yellow through orange to red.

• 'redyellow': from red through orange to yellow.

• 'purpleorange': from purple through white to orange.

• 'orangepurple': from orange through white to purple.

A number indicating how many colors to generate.

Can be provided in two formats:

• A single value with the number of breaks to be generated automatically, between the minimum and maximum specified in 'var_limits' (both inclusive). Hence the parameter 'var_limits' is mandatory if 'brks' is provided with this format. If 'bar_limits' is additionally provided, values only between 'bar_limits' will be generated. The higher the value of 'brks', the smoother the plot will look.

• A vector with the actual values of the desired breaks. Values will be reordered by force to ascending order. If provided in this format, no other parameters are required to generate/plot the colour bar.

This parameter is optional if 'var_limits' is specified. If 'brks' not specified but 'cols' is specified, it will take as value length(cols) + 1. If 'cols' is not specified either, 'brks' will take 21 as value.

Vector of length(brks) - 1 valid colour identifiers, for each interval defined by the breaks. This parameter is optional and will be filled in with a vector of length(brks) - 1 colours generated with the function provided in 'color_fun' (clim.colors by default).
'cols' can have one additional colour at the beginning and/or at the end with the aim to colour field values beyond the range of interest represented in the colour bar. If any of these extra colours is provided, parameter 'triangle_ends' becomes mandatory in order to disambiguate which of the ends the colours have been provided for.

TRUE/FALSE for vertical/horizontal colour bar (disregarded if plot = FALSE).

The first of each subsampleg breaks will be ticked on the colorbar. Takes by default an approximation of a value that yields a readable tick arrangement (extreme breaks always ticked). If set to 0 or lower, no labels are drawn. See the code of the function for details or use 'bar_extra_labels' for customized tick arrangements.

Vector of two numeric values with the extremes of the range of values represented in the colour bar. If 'var_limits' go beyond this interval, the drawing of triangle extremes is triggered at the corresponding sides, painted in 'col_inf' and 'col_sup'. Either of them can be set as NA and will then take as value the corresponding extreme in 'var_limits' (hence a triangle end won't be triggered for these sides). Takes as default the extremes of 'brks' if available, else the same values as 'var_limits'.

Vector of two numeric values with the minimum and maximum values of the field to represent. These are used to know whether to draw triangle ends at the extremes of the colour bar and what colour to fill them in with. If not specified, take the same value as the extremes of 'brks'. Hence the parameter 'brks' is mandatory if 'var_limits' is not specified.

Vector of two logical elements, indicating whether to force the drawing of triangle ends at each of the extremes of the colour bar. This choice is automatically made from the provided 'brks', 'bar_limits', 'var_limits', 'col_inf' and 'col_sup', but the behaviour can be manually forced to draw or not to draw the triangle ends with this parameter. If 'cols' is provided, 'col_inf' and 'col_sup' will take priority over 'triangle_ends' when deciding whether to draw the triangle ends or not.

Colour to fill the inferior triangle end with. Useful if specifying colours manually with parameter 'cols', to specify the colour and to trigger the drawing of the lower extreme triangle, or if 'cols' is not specified, to replace the colour automatically generated by ColorBar().

Colour to fill the superior triangle end with. Useful if specifying colours manually with parameter 'cols', to specify the colour and to trigger the drawing of the upper extreme triangle, or if 'cols' is not specified, to replace the colour automatically generated by ColorBar().

Function to generate the colours of the color bar. Must take an integer and must return as many colours. The returned colour vector can have the attribute 'na_color', with a colour to draw NA values. This parameter is set by default to ClimPalette().

Logical value indicating whether to only compute its breaks and colours (FALSE) or to also draw it on the current device (TRUE).

Whether to draw ticks for the labels along the colour bar (TRUE) or not (FALSE). TRUE by default. Disregarded if 'plot = FALSE'.

Whether to draw black lines in the borders of each of the colour rectancles of the colour bar (TRUE) or not (FALSE). FALSE by default. Disregarded if 'plot = FALSE'.

Scale factor for the drawn triangle ends of the colour bar, if drawn at all. Takes 1 by default (rectangle triangle proportional to the thickness of the colour bar). Disregarded if 'plot = FALSE'.

Numeric vector of extra labels to draw along axis of the colour bar. The number of provided decimals will be conserved. Disregarded if 'plot = FALSE'.

Deprecated. Use 'bar_extra_labels' instead.

Title to draw on top of the colour bar, most commonly with the units of the represented field in the neighbour figures. Empty by default.

Scale factor for the 'title' of the colour bar. Takes 1 by default.

Scale factor for the labels of the colour bar. Takes 1 by default.

Deprecated. Use 'bar_label_scale' instead.

Scale factor for the length of the ticks of the labels along the colour bar. Takes 1 by default.

Deprecated. Use 'bar_tick_scale' instead.

Extra margins to be added around the colour bar, in the format c(y1, x1, y2, x2). The units are margin lines. Takes rep(0, 4) by default.

Deprecated. Use 'bar_extra_margin' instead.

Number of significant digits to be displayed in the labels of the colour bar, usually to avoid too many decimal digits overflowing the figure region. This does not have effect over the labels provided in 'bar_extra_labels'. Takes 4 by default.

Deprecated. Use 'bar_label_digits' instead.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bg bty cex.lab cex.main cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg fig fin font font.axis font.lab font.main font.sub lend lheight ljoin lmitre lty lwd mai mex mfcol mfrow mfg mkh oma omd omi page pch pin plt pty smo srt tck tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog.
For more information about the parameters see 'par'.

Breaks used for splitting the range in intervals.

Colours generated for each of the length(brks) - 1 intervals. Always of length length(brks) - 1.

Colour used to draw the lower triangle end in the colour bar (NULL if not drawn at all).

Colour used to draw the upper triangle end in the colour bar (NULL if not drawn at all).

Can be provided in two formats:

• A single value with the number of breaks to be generated automatically, between the minimum and maximum specified in 'var_limits' (both inclusive). Hence the parameter 'var_limits' is mandatory if 'brks' is provided with this format. If 'bar_limits' is additionally provided, values only between 'bar_limits' will be generated. The higher the value of 'brks', the smoother the plot will look.

• A vector with the actual values of the desired breaks. Values will be reordered by force to ascending order. If provided in this format, no other parameters are required to generate/plot the colour bar.

This parameter is optional if 'var_limits' is specified. If 'brks' not specified but 'cols' is specified, it will take as value length(cols) + 1. If 'cols' is not specified either, 'brks' will take 21 as value.

Vector of length(brks) - 1 valid colour identifiers, for each interval defined by the breaks. This parameter is optional and will be filled in with a vector of length(brks) - 1 colours generated with the function provided in 'color_fun' (clim.colors by default).
'cols' can have one additional colour at the beginning and/or at the end with the aim to colour field values beyond the range of interest represented in the colour bar. If any of these extra colours is provided, parameter 'triangle_ends' becomes mandatory in order to disambiguate which of the ends the colours have been provided for.

TRUE/FALSE for vertical/horizontal colour bar (disregarded if plot = FALSE).

The first of each subsampleg breaks will be ticked on the colorbar. Takes by default an approximation of a value that yields a readable tick arrangement (extreme breaks always ticked). If set to 0 or lower, no labels are drawn. See the code of the function for details or use 'bar_extra_labels' for customized tick arrangements.

Vector of two numeric values with the extremes of the range of values represented in the colour bar. If 'var_limits' go beyond this interval, the drawing of triangle extremes is triggered at the corresponding sides, painted in 'col_inf' and 'col_sup'. Either of them can be set as NA and will then take as value the corresponding extreme in 'var_limits' (hence a triangle end won't be triggered for these sides). Takes as default the extremes of 'brks' if available, else the same values as 'var_limits'.

Vector of two numeric values with the minimum and maximum values of the field to represent. These are used to know whether to draw triangle ends at the extremes of the colour bar and what colour to fill them in with. If not specified, take the same value as the extremes of 'brks'. Hence the parameter 'brks' is mandatory if 'var_limits' is not specified.

Function to generate the colours of the color bar. Must take an integer and must return as many colours. The returned colour vector can have the attribute 'na_color', with a colour to draw NA values. This parameter is set by default to ClimPalette().

Logical value indicating whether to only compute its breaks and colours (FALSE) or to also draw it on the current device (TRUE).

Whether to draw ticks for the labels along the colour bar (TRUE) or not (FALSE). TRUE by default. Disregarded if 'plot = FALSE'.

Whether to draw black lines in the borders of each of the colour rectancles of the colour bar (TRUE) or not (FALSE). FALSE by default. Disregarded if 'plot = FALSE'.

A charater string vector of the names of colors. Must be the same length as 'cols'.

Numeric vector of extra labels to draw along axis of the colour bar. The number of provided decimals will be conserved. Disregarded if 'plot = FALSE'.

Deprecated. Use 'bar_extra_labels' instead.

Title to draw on top of the colour bar, most commonly with the units of the represented field in the neighbour figures. Empty by default.

Scale factor for the 'title' of the colour bar. Takes 1 by default.

Scale factor for the labels of the colour bar. Takes 1 by default.

Deprecated. Use 'bar_label_scale' instead.

Scale factor for the length of the ticks of the labels along the colour bar. Takes 1 by default.

Deprecated. Use 'bar_tick_scale' instead.

Extra margins to be added around the colour bar, in the format c(y1, x1, y2, x2). The units are margin lines. Takes rep(0, 4) by default.

Deprecated. Use 'bar_extra_margin' instead.

Number of significant digits to be displayed in the labels of the colour bar, usually to avoid too many decimal digits overflowing the figure region. This does not have effect over the labels provided in 'bar_extra_labels'. Takes 4 by default.

Deprecated. Use 'bar_label_digits' instead.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bg bty cex.lab cex.main cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg fig fin font font.axis font.lab font.main font.sub lend lheight ljoin lmitre lty lwd mai mex mfcol mfrow mfg mkh oma omd omi page pch pin plt pty smo srt tck tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog.
For more information about the parameters see 'par'.

Breaks used for splitting the range in intervals.

Colours generated for each of the length(brks) - 1 intervals. Always of length length(brks) - 1.

Logical or binary (0/1) array with two named dimensions: c(latitude, longitude).Hatching is applied to grid cells where 'hatching_mask' is TRUE (or 1). Arrays with dimensions c(longitude, latitude) are also accepted, but the resulting hatching may appear transposed. To ensure correct alignment with the map, provide 'data'. The function will compare the dimension order of 'hatching_mask' and 'data', and automatically transpose 'hatching_mask' if the latitude and longitude dimensions appear to be reversed.

Numeric vector of latitude locations of the cell centers of the grid.

Numeric vector of longitude locations of the cell centers of the grid.

Array of the data that the hatching will be drawn over. The array should have named latidude and longitude dimensions. If the dimension order is reversed relative to 'hatching_mask', the mask is automatically transposed. Default is NULL.

The density of shading lines, in lines per inch. A zero value of density means no shading nor filling, whereas negative values and NA suppress shading (and so allow color filling). NULL means that no shading lines are drawn. Default is 10.

The slope of shading lines, given as an angle in degrees (counter-clockwise). Default is 45.

Color of the hatching lines. Default is "#252525".

The line width, a positive number. The interpretation is device-specific, and some devices do not implement line widths less than one. Default is 0.5.

A logical value indicating crosshatching. If TRUE, adds a second set of lines in the opposite angle. Default is FALSE.

A character string indicating the shp file path.

A character string indicating the path to the reference data. Either (1) a netCDF file or (2) a list of lon and lat to provide the reference grid points. It is NULL by default.

A logical value indicating the method to find the intersection of the reference grid and the shapefile. When it is TRUE, the method used is the calculation of the area coverage fraction of intersection. If it is FALSE, the method used is searching if the centroid of the grid cell falls inside the shapefile or not. It is FALSE by default.

A character string containing the Shapefile System Database Name used to subset the shapefile into regions by using parameters 'reg_ids' or 'reg_names'. The accepted systems are: 'NUTS', 'LAU', and 'GADM'. When it is used, you must specify either 'reg_ids' or 'reg_names'; if you don't need to subset different regions, set it to NULL. It is set to "NUTS" by default (optional).

A named list of character string vectors indicating the country and the region name. The name of the list stands for the country name code and the vector character strings indicate the region name for each country. It is NULL by default (optional).

A character string indicating the unique ID in shapefile. It is NULL by default (optional).

An integer number from 1 to 3 indicating the 'NUTS' dataset level. For other datasets this parameter is not used. One mask can only have a unique level. It is set to 3 by default (optional).

A character string indicating the latitudinal dimension. If it is NULL, the latitudinal name will be searched using an internal function with the following possible names: 'lat', 'latitude', 'y', 'j' and 'nav_lat'. It is set to NULL by default.

A character string indicating the longitudinal dimension. If it is NULL, the longitudinal name will be searched using an internal function with the following possible names: 'lon', 'longitude', 'x', 'i' and 'nav_lon'. It is set to NULL by default.

A logical value indicating if we want a dimension for the regions in the resulting mask array. It is FALSE by default.

A logical value that when it is TRUE it uses the function 'sf::st_make_valid' applied to the shapefile and to the coordinates.

A logical value indicating if we want to look for the nearest coordinate between the shapefile region and the reference grid when there is no intersection between the shapefile and the reference grid. It is FALSE by default.

A numeric value indicating the maximum distance is accepted to the closest gridpoint when there is no intersection between the shapefile and the reference grid.

The number of parallel processes to spawn for the use for parallel computation in multiple cores.

A character string of the path to save the NetCDF mask. If not specified (default), only the mask array will be returned.

A character string indicating if your GIS files has a grid in degrees or meters. If it is NULL, the units will be set as "meters" with the following possible names: 'degrees', 'meters'

A character string indicating in the shape file which is the name of the column with the values of the IDs of the different polygons. It is NULL by default.

A character string indicating in the shape file which is the name of the column with the values of the names of the different polygons. It is NULL by default.

Arguments passed on to 's2_options' in function 'st_intersection'. See 's2 package'.

Matrix of dimensions (nexp/nmod, nltime).

Matrix of dimensions (nexp/nmod, nltime).

Main title, optional.

Title of Y-axis, optional.

Starting month between 1 and 12. Default = 1.

1 = yearly, 12 = monthly, 4 = seasonal, ... Default = 12.

Number of ticks and labels on the x-axis, optional.

c(lower limit, upper limit): limits of the Y-axis, optional.

List of experiment names, up to three, optional.

List of names of input variables, optional.

TRUE/FALSE for presentation/paper plot. Default = FALSE.

c(a, b, ...) Add horizontal black lines at Y-positions a, b, ... The default value is NULL.

TRUE/FALSE if legend should be added or not to the plot. Default = TRUE.

Deprecated. Use 'drawleg' instead.

TRUE/FALSE if significance level should replace confidence interval.
Default = FALSE.

Multiplicative factor to change title size, optional.

Deprecated. Use 'title_scale' instead.

TRUE/FALSE to show/not confidence intervals for input variables.

Name of output file. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff. The default value is NULL.

File width, in the units specified in the parameter size_units (inches by default). Takes 8 by default.

File height, in the units specified in the parameter size_units (inches by default). Takes 5 by default.

Units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bg bty cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg fig font font.axis font.lab font.main font.sub lend lheight ljoin lmitre mar mex mfcol mfrow mfg mkh oma omd omi page pch plt smo srt tck tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog
For more information about the parameters see 'par'.

An ACC array with with dimensions:
c(nexp, nobs, nsdates, nltime, 4)
with the fourth dimension of length 4 containing the lower limit of the 95% confidence interval, the ACC, the upper limit of the 95% confidence interval and the 95% significance level.

A character vector of startdates: c('YYYYMMDD','YYYYMMDD').

A character string of the main title, optional.

A multiplicative factor to scale title size, optional.

Deprecated. Use 'title_scale' instead.

A character string of the title of Y-axis for each experiment: c(”, ”), optional.

A numeric vector c(lower limit, upper limit): limits of the Y-axis, optional.

A character vector of flags to be written in the legend, optional.

A integer: 1 = yearly, 12 = monthly, 4 = seasonal, ... Default: 12.

A logical value for presentation/paper plot, Default = FALSE.

A logical value if filled confidence interval. Default = FALSE.

A logical value if a line at y=0 should be added. Default = FALSE.

A logical value if points instead of lines. Default = TRUE.
Must be TRUE if only 1 leadtime.

A vector of x location where to add vertical black lines, optional.

A character string of the output file name. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff. Default is NULL.

A numeric of the file width, in the units specified in the parameter size_units (inches by default). Takes 8 by default.

A numeric of the file height, in the units specified in the parameter size_units (inches by default). Takes 5 by default.

A character string of the units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bg bty cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg fig fin font font.axis font.lab font.main font.sub lend lheight ljoin lmitre mar mex mfcol mfrow mfg mkh oma omd omi page plt smo srt tck tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog
For more information about the parameters see 'par'.

Matrix of dimensions (nltime, nlat, nlon) or (nexp/nmod, nltime, nlat, nlon) or (nexp/nmod, 3/4, nltime, nlat, nlon) or (nexp/nmod, nobs, 3/4, nltime, nlat, nlon).

Vector containing longtitudes (degrees).

Vector containing latitudes (degrees).

c(”,”, ...) array of main title for each animation, optional. If RMS, RMSSS, correlations: first exp with successive obs, then second exp with successive obs, etc ...

Scale factor for the figure top title. Defaults to 1.

Deprecated. Use 'title_scale' instead.

Units, optional.

Starting month between 1 and 12. Default = 1.

1 = yearly, 12 = monthly, 4 = seasonal ...

TRUE/FALSE grid points with dots if 95% significance level reached. Default = FALSE.

Limits of colour levels, optional. For example: seq(min(data), max(data), (max(data) - min(data)) / 10).

Vector of colours of length(brks) - 1, optional.

Continents filled in grey (TRUE) or represented by a black line (FALSE). Default = TRUE. Filling unavailable if crossing Greenwich and equi = TRUE. Filling unavailable if square = FALSE and equi = TRUE.

Westward limit of the domain to plot (> 0 or < 0). Default : 0 degrees.

Eastward limit of the domain to plot (> 0 or < 0). lonmax > lonmin. Default : 360 degrees.

Southward limit of the domain to plot. Default : -90 degrees.

Northward limit of the domain to plot. Default : 90 degrees.

Interval between longitude ticks on x-axis. Default = 20 degrees.

Interval between latitude ticks on y-axis for equi = TRUE or between latitude circles for equi = FALSE. Default = 30 degrees.

Draw a colorbar. Can be FALSE only if square = FALSE or equi = FALSE. Default = TRUE.

Supsampling factor of the interval between ticks on colorbar. Default = 1 = every colour level.

Color used to represent NA. Default = 'white'.

TRUE/FALSE == cylindrical equidistant/stereographic projection. Default: TRUE.

c(”, ”, ...) array of output file name for each animation. If RMS, RMSSS, correlations : first exp with successive obs, then second exp with successive obs, etc ...

Deprecated. Use 'data' instead.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bty cex cex.axis cex.lab cex.main cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg fig font font.axis font.lab font.main font.sub las lheight ljoin lmitre lty lwd mai mar mex mfcol mfrow mfg mgp mkh oma omd omi page pch plt pty smo srt tck tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog.
For more information about the parameters see 'par'.

A numerical array containing the experimental data:
c(nmod/nexp, nmemb/nparam, nsdates, nltime).

A numerical array containing the observational data:
c(nobs, nmemb, nsdates, nltime)

A character vector of start dates in the format of c('YYYYMMDD','YYYYMMDD').

Main title for each experiment: c(”,”), optional.

Title of Y-axis for each experiment: c(”,”), optional.

c(lower limit, upper limit): limits of the Y-axis, optional.

List of observational dataset names, optional.

1 = yearly, 12 = monthly, 4 = seasonal, ... Default: 12.

TRUE/FALSE for presentation/paper plot. Default = FALSE.

TRUE/FALSE if the spread between members should be filled. Default = TRUE.

TRUE/FALSE if all members/only the ensemble-mean should be plotted.
Default = TRUE.

TRUE/FALSE if the ensemble-mean should be plotted. Default = TRUE.

TRUE/FALSE if a line at y=0 should be added. Default = FALSE.

TRUE/FALSE if points instead of lines should be shown. Default = FALSE.

List of x location where to add vertical black lines, optional.

Multiplicative factor to scale title size, optional.

Deprecated. Use 'title_scale' instead.

Name of the output file for each experiment: c(”,”). Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff. If filenames with different extensions are passed, it will be considered only the first one and it will be extended to the rest. The default value is NULL, which the pop-up window shows.

File width, in the units specified in the parameter size_units (inches by default). Takes 8 by default.

File height, in the units specified in the parameter size_units (inches by default). Takes 5 by default.

Units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bg bty cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg fig font font.axis font.lab font.main font.sub lend lheight ljoin lmitre mar mex mfcol mfrow mfg mkh oma omd omi page plt smo srt tck tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog
For more information about the parameters see 'par'.

Forecast array of multi-member time series, e.g., the NAO index of one experiment. The expected dimensions are c(members, start dates/forecast horizons). A vector with only the time dimension can also be provided. Only monthly or lower frequency time series are supported. See parameter freq.

Observational vector or array of time series, e.g., the NAO index of the observations that correspond the forecast data in exp. The expected dimensions are c(start dates/forecast horizons) or c(1, start dates/forecast horizons). Only monthly or lower frequency time series are supported. See parameter freq.

Character string to be drawn as figure title.

Character string to be drawn as y-axis title.

Number of the month of the first time step, from 1 to 12.

Year of the first time step.

Frequency of the provided time series: 1 = yearly, 12 = monthly,

Experimental dataset name.

Name of the observational reference dataset.

TRUE/FALSE: whether to draw the legend or not.

Name of output file. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff.
Default = 'output_PlotBox.ps'.

File width, in the units specified in the parameter size_units (inches by default). Takes 8 by default.

File height, in the units specified in the parameter size_units (inches by default). Takes 5 by default.

Units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Arguments to be passed to the method. Only accepts the following graphical parameters:
ann ask bg cex.lab cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg fig font font.axis font.lab font.main font.sub lend lheight ljoin lmitre mex mfcol mfrow mfg mkh oma omd omi page pin plt pty smo srt tck tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog
For more information about the parameters see 'par'.

Matrix containing the experimental data with dimensions:
c(nmod/nexp, nmemb/nparam, nltime) or c(nmod/nexp, nltime)

Matrix containing the observational data (optional) with dimensions:
c(nobs, nmemb, nltime) or c(nobs, nltime)

Main title, optional.

Title of Y-axis, optional.

Starting month between 1 and 12. Default = 1.

1 = yearly, 12 = monthly, 4 = seasonal, ... Default = 12.

c(lower limit, upper limit): limits of the Y-axis, optional.

List of experiment names, optional.

List of observational dataset names, optional.

TRUE/FALSE for presentation/paper plot. Default = FALSE.

TRUE/FALSE to plot the legend or not. Default = TRUE.

Deprecated. Use 'drawleg' instead.

Multiplicative factor to scale title size, optional.

Deprecated. Use 'title_scale' instead.

Name of output file. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff. The default value is NULL, which the figure is shown in a pop-up window.

File width, in the units specified in the parameter size_units (inches by default). Takes 8 by default.

File height, in the units specified in the parameter size_units (inches by default). Takes 5 by default.

Units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bg bty cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg fig font font.axis font.lab font.main font.sub lend lheight ljoin lmitre mar mex mfcol mfrow mfg mkh oma omd omi page pch plt smo srt tck usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog
For more information about the parameters see 'par'.

List of matrices to plot, each with (longitude, latitude) dimensions, or 3-dimensional array with the dimensions (longitude, latitude, map). Dimension names are required.

Vector of longitudes. Must match the length of the corresponding dimension in 'maps'.

Vector of latitudes. Must match the length of the corresponding dimension in 'maps'.

Function that selects, for each grid point, which value to take among all the provided maps. This function receives as input a vector of values for a same grid point for all the provided maps, and must return a single selected value (not its index!) or NA. For example, the min and max functions are accepted.

Range of values to be displayed for all the maps. This must be a numeric vector c(range min, range max). The values in the parameter 'maps' can go beyond the limits specified in this range. If the selected value for a given grid point (according to 'map_select_fun') falls outside the range, it will be coloured with 'col_unknown_map'.

Optional name for the dimension of 'maps' along which the multiple maps are arranged. Only applies when 'maps' is provided as a 3-dimensional array. Takes the value 'map' by default.

Colour levels to be sent to VizEquiMap. This parameter is optional and adjusted automatically by the function.

List of vectors of colours to be sent to VizEquiMap for the colour bar of each map. This parameter is optional and adjusted automatically by the function (up to 5 maps). The colours provided for each colour bar will be automatically interpolated to match the number of breaks. Each item in this list can be named, and the name will be used as title for the corresponding colour bar (equivalent to the parameter 'bar_titles').

A numeric vector of 2 indicating the range of color bar. The default is NULL, and the function will decide the range automatically.

A logical vector of two indicating if the lower and upper triangles of the color bar should be plotted. The default is c(FALSE, FALSE).

A character string of recognized color name or code indicating the color of the lower triangle of the color bar. The default is NULL.

A character string of recognized color name or code indicating the color of the upper triangle of the color bar. The default is NULL.

Colour to use to paint the grid cells for which a map is not possible to be chosen according to 'map_select_fun' or for those values that go beyond 'display_range'. Takes the value 'white' by default.

Optional numeric array with dimensions (latitude, longitude), with values in the range [0, 1], indicating the opacity of the mask over each grid point. Cells with a 0 will result in a totally opaque superimposed pixel coloured in 'mask_color', whereas cells with a 1 will have no mask and remain totally visible.

Colour to be used for the superimposed mask (if specified in 'mask'). Takes the value 'grey' by default.

Deprecated. Use 'mask_color' instead.

Array of same dimensions as 'var' or with dimensions c(n, dim(var)), where n is the number of dot/symbol layers to add to the plot. A value of TRUE at a grid cell will draw a dot/symbol on the corresponding square of the plot. By default all layers provided in 'dots' are plotted with dots, but a symbol can be specified for each of the layers via the parameter 'dot_symbol'.

Optional vector of character strings providing the titles to be shown on top of each of the colour bars.

Scale factor for the size of the colour bar labels. Takes 1 by default.

Deprecated. Use 'bar_label_scale' instead.

Scale factor for the sizes of the bar titles. Takes 1.5 by default.

Numeric vector of length 4 for the margin sizes in the following order: bottom, left, top, and right. If not specified (NULL), the default of par("mar"), c(5.1, 4.1, 4.1, 2.1), is used. Default is NULL.

Deprecated. Use 'margin_scale' instead.

A numeric vector of 4 indicating the extra margins to be added around the color bar, in the format c(y1, x1, y2, x2). The units are margin lines. The default values are c(2, 0, 2, 0).

File where to save the plot. If not specified (default) a graphics device will pop up. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff

File width, in the units specified in the parameter 'size_units' (inches by default). Takes 8 by default.

File height, in the units specified in the parameter 'size_units' (inches by default). Takes 5 by default.

Units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Where to draw the common colour bar. Can take values TRUE, FALSE or:
'up', 'u', 'U', 'top', 't', 'T', 'north', 'n', 'N'
'down', 'd', 'D', 'bottom', 'b', 'B', 'south', 's', 'S' (default)
'right', 'r', 'R', 'east', 'e', 'E'
'left', 'l', 'L', 'west', 'w', 'W'

A logical value indicating if the color bars information should be returned by the function. If TRUE, the function doesn't plot the color bars but still creates the layout with color bar areas, and the arguments for GradientCatsColorBar() or ColorBarContinuous() will be returned. It is convenient for users to adjust the color bars manually. The default is FALSE, the color bars will be plotted directly.

Additional parameters to be passed on to VizEquiMap.

Array with the values at each cell of a grid on a regular rectangular or gaussian grid. The array is expected to have two dimensions: c(latitude, longitude). Longitudes can be in ascending or descending order and latitudes in any order. It can contain NA values (coloured with 'colNA'). Arrays with dimensions c(longitude, latitude) will also be accepted but 'lon' and 'lat' will be used to disambiguate so this alternative is not appropriate for square arrays. It is allowed that the positions of the longitudinal and latitudinal coordinate dimensions are interchanged.

Numeric vector of longitude locations of the cell centers of the grid of 'data', in ascending or descending order (same as 'data'). Expected to be regularly spaced, within either of the ranges [-180, 180] or [0, 360]. Data for two adjacent regions split by the limits of the longitude range can also be provided, e.g. lon = c(0:50, 300:360) ('data' must be provided consitently).

Numeric vector of latitude locations of the cell centers of the grid of 'data', in any order (same as 'data'). Expected to be from a regular rectangular or gaussian grid, within the range [-90, 90].

Array of the zonal component of wind/current/other field with the same dimensions as 'data'. It is allowed that the positions of the longitudinal and latitudinal coordinate dimensions are interchanged.

Array of the meridional component of wind/current/other field with the same dimensions as 'data'. It is allowed that the positions of the longitudinal and latitudinal coordinate dimensions are interchanged.

Top title of the figure, scalable with parameter 'title_scale'.

Scale factor for the figure top title provided in parameter 'toptitle'. Deprecated. Use 'title_scale' instead.

A character string of the caption located at the left-bottom of the plot. Captions with multiple lines can be constructed using string manipulation functions like paste() or paste0(), using "\n" to indicate line breaks.

Title at the top of the colour bar, most commonly the units of the variable provided in parameter 'data'.

Usually only providing 'brks' is enough to generate the desired colour bar. These parameters allow to define n breaks that define n - 1 intervals to classify each of the values in 'data'. The corresponding grid cell of a given value in 'data' will be coloured in function of the interval it belongs to. These parameters are sent to ColorBar() to generate the breaks and colours. Additional colours for values beyond the limits of the colour bar are also generated and applied to the plot if 'bar_limits' or 'brks' and 'triangle_ends' are properly provided to do so. See ?ColorBar for a full explanation.

Colour identifiers to colour the values in 'data' that go beyond the extremes of the colour bar and to colour NA values, respectively. 'colNA' takes attr(cols, 'na_color') if available by default, where cols is the parameter 'cols' if provided or the vector of colors returned by 'color_fun'. If not available, it takes 'pink' by default. 'col_inf' and 'col_sup' will take the value of 'colNA' if not specified. See ?ColorBar for a full explanation on 'col_inf' and 'col_sup'.

Set of parameters to control the visual aspect of the drawn colour bar (1/3). See ?ColorBar for a full explanation.

Logical value to choose either to draw a coloured square for each grid cell in 'data' (TRUE; default) or to draw contour lines and fill the spaces in between with colours (FALSE). In the latter case, 'filled.continents' will take the value FALSE if not specified.

Colour to fill in drawn projected continents. If 'square = FALSE', it is set as FALSE. If set to FALSE (default), the continents are not filled.

A logical value or the color name to fill in drawn projected oceans. The default value is FALSE. If it is TRUE, the default colour is "light blue".

A logical value indicating if the country borders should be plotted (TRUE) or not (FALSE). It only works when 'filled.continents' is FALSE. The default value is FALSE.

Colour of the coast line of the drawn projected continents. Takes the value gray(0.5) by default.

Line width of the coast line of the drawn projected continents. Takes the value 1 by default.

Colour of the lake or other water body inside continents. The default value is NULL.

A character string of the path to a .rds file or a list object containinig shape file data. If it is a .rds file, it should contain a list. The list should contains 'x' and 'y' at least, which indicate the location of the shape. The default value is NULL.

Line color of the shapefile.

Line width of the shapefile. The default value is 1.

Array of same dimensions as 'data' to be added to the plot and displayed with contours. Parameter 'brks2' is required to define the magnitude breaks for each contour curve. Disregarded if 'square = FALSE'. It is allowed that the positions of the longitudinal and latitudinal coordinate dimensions are interchanged.

Vector of magnitude breaks where to draw contour curves for the array provided in 'contours' or if 'square = FALSE'.

Line width of the contour curves provided via 'contours' and 'brks2', or if 'square = FALSE'.

Line color of the contour curves provided via 'contours' and 'brks2', or if 'square = FALSE'.

Line type of the contour curves. Takes 1 (solid) by default. See help on 'lty' in par() for other accepted values.

A logical value indicating whether to draw the contour labels or not. The default value is TRUE.

Scale factor for the superimposed labels when drawing contour levels.

Array of same dimensions as 'data' or with dimensions c(n, dim(data)), where n is the number of dot/symbol layers to add to the plot. A value of TRUE at a grid cell will draw a dot/symbol on the corresponding square of the plot. By default all layers provided in 'dots' are plotted with dots, but a symbol can be specified for each of the layers via the parameter 'dot_symbol'. It is allowed that the positions of the longitudinal and latitudinal coordinate dimensions are interchanged.

Single character/number or vector of characters/numbers that correspond to each of the symbol layers specified in parameter 'dots'. If a single value is specified, it will be applied to all the layers in 'dots'. Takes 4 (cross) by default. See 'pch' in par() for additional accepted options.

Scale factor for the dots/symbols to be plotted, specified in 'dots'. If a single value is specified, it will be applied to all layers in 'dots'. Takes 1 by default.

An array with the same dimensions as 'data' with values in the range of [0, 1] or logical, indicating the opacity of the mask over each grid point. Cells with a 0 or FALSE will result in a totally opaque superimposed pixel coloured in 'mask_color', whereas cells with a 1 or TRUE will have no mask and remain totally visible. If the array is numeric, values between 0 and 1 will have shades of transparency.

Color of the mask. The default value is 'white'.

Subsampling factor to select a subset of arrows in 'varu' and 'varv' to be drawn. Only one out of arr_subsamp arrows will be drawn. Takes 1 by default.

Scale factor for drawn arrows from 'varu' and 'varv'. Takes 1 by default.

Length of the refence arrow to be drawn as legend at the bottom of the figure (in same units as 'varu' and 'varv', only affects the legend for the wind or variable in these arrays). Defaults to 15.

Units of 'varu' and 'varv', to be drawn in the legend. Takes 'm/s' by default.

Parameter for the scale of the shaft of the arrows (which also depend on the number of figures and the arr_scale parameter). Defaults to 1.

Parameter for the scale of the angle of the shaft of the arrows (which also depend on the number of figure and the arr_scale parameter). Defaults to 1.

Whether to draw longitude and latitude axes or not. TRUE by default.

Whether to label the longitude axis with a 'W' instead of minus for negative values. Defaults to FALSE.

A numeric of the distance of the longitude labels to the box borders. The default value is NULL and is automatically adjusted by the function.

A numeric of the distance of the latitude labels to the box borders. The default value is NULL and is automatically adjusted by the function.

A logical indicating whether to include degree symbol (30° N) or not (30N; default).

Interval between latitude ticks on y-axis, in degrees. Defaults to 20.

Interval between latitude ticks on x-axis, in degrees. Defaults to 20.

A numeric of the degrees to shift the latitude ticks. The default value is 0.

A numeric of the degrees to shift the longitude ticks. The default value is 0.

A vector of character string of the custumized x-axis labels. The values should correspond to each tick, which is decided by the longitude and parameter 'intxlon'. The default value is NULL and the labels will be automatically generated.

A vector of character string of the custumized y-axis labels. The values should correspond to each tick, which is decided by the latitude and parameter 'intylat'. The default value is NULL and the labels will be automatically generated.

Scale factor for the tick lines along the longitude and latitude axes.

Scale factor for the labels along the longitude and latitude axes.

Whether to plot a color bar (legend, key) or not. Defaults to TRUE. It is not possible to plot the colour bar if 'add = TRUE'. Use ColorBar() and the return values of PlotEquiMap() instead.

TRUE/FALSE for vertical/horizontal colour bar. Default is FALSE. Parameters 'width' and 'height' might need to be modified to accommodate the vertical colour bar.

Set of parameters to control the visual aspect of the drawn colour bar (2/3). See ?ColorBar for a full explanation.

Set of parameters to control the visual aspect of the drawn colour bar (3/3). See ?ColorBar for a full explanation.

Logical value indicating whether to include the minimum value of the field. Takes TRUE by default.

Logical value indicating whether to include the maximum value of the field. Takes TRUE by default.

Logical or binary (0/1) array with two named dimensions: c(latitude, longitude). Hatching is applied to grid cells where 'hatching_mask' is TRUE (or 1). Arrays with dimensions c(longitude, latitude) are also accepted, but the resulting hatching may appear transposed. To ensure correct alignment with the map, provide 'data'. The function will compare the dimension order of 'hatching_mask' and 'data', and automatically transpose 'hatching_mask' if the latitude and longitude dimensions appear to be reversed.

The density of shading lines, in lines per inch. A zero value of density means no shading nor filling, whereas negative values and NA suppress shading (and so allow color filling). NULL means that no shading lines are drawn. Default is 10.

The slope of shading lines, given as an angle in degrees (counter-clockwise). Default is 45.

Color of the hatching lines. Default is "#252525".

The line width, a positive number. The interpretation is device-specific, and some devices do not implement line widths less than one. Default is 0.5.

A logical value indicating crosshatching. If TRUE, adds a second set of lines in the opposite angle. Default is FALSE.

Limits of a box to be added to the plot, in degrees: c(x1, y1, x2, y2). A list with multiple box specifications can also be provided.

Colour of the box lines. A vector with a colour for each of the boxes is also accepted. Defaults to 'purple2'.

Line width of the box lines. A vector with a line width for each of the boxes is also accepted. Defaults to 5.

Scale factor for the margins around the map plot, with the format c(y1, x1, y2, x2). Defaults to rep(1, 4). If drawleg = TRUE, then margin_scale[1] is subtracted 1 unit.

Scale factor for the figure top title. Defaults to 1.

Scale factor for the figure caption. Default is 0.8 (1 if vertical = TRUE).

Number of figures in the layout the plot will be put into. A higher numbfig will result in narrower margins and smaller labels, axe labels, ticks, thinner lines, ... Defaults to 1.

File where to save the plot. If not specified (default) a graphics device will pop up. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff.

File width, in the units specified in the parameter 'size_units' (inches by default). Takes 8 by default.

File height, in the units specified in the parameter 'size_units' (inches by default). Takes 5 by default.

Units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Deprecated. Use 'data' instead.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bg bty cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg font font.axis font.lab font.main font.sub lend lheight ljoin lmitre mex mfcol mfrow mfg mkh omd omi page pch pin plt pty smo srt tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog
For more information about the parameters see 'par'.

Breaks used for colouring the map (and legend if drawleg = TRUE).

Colours used for colouring the map (and legend if drawleg = TRUE). Always of length length(brks) - 1.

Colour used to draw the lower triangle end in the colour bar (NULL if not drawn at all).

Colour used to draw the upper triangle end in the colour bar (NULL if not drawn at all).

A dataframe or array containing all the ensember members for each forecast. If 'fcst' is an array, it should have two labelled dimensions, and one of them should be 'members'. If 'fcsts' is a data.frame, each column shoul be a separate forecast, with the rows beeing the different ensemble members.

An array or vector with P33 and P66 values that define the tercile categories for each panel. Use an array of dimensions (nforecasts,2) to define different terciles for each forecast panel, or a vector with two elements to reuse the same tercile limits for all forecast panels.

(optional) An array or vector with P10 and P90 values that define the extreme categories for each panel. Use an array of (nforecasts,2) to define different extreme limits for each forecast panel, or a vector with two elements to reuse the same tercile limits for all forecast panels. (Default: extreme categories are not shown).

(optional) A vector providing the observed values for each forecast panel or a single value that will be reused for all forecast panels. (Default: observation is not shown).

A string with the plot main title.

Deprecated. Use 'toptitle' instead.

A string with the variable name and units.

A string with the title of the legend showing the probabilistic categories. By default, it is set to "Probability of terciles".

A vector of strings with the name of the probabilistic categories. By default, it is set to c("Below normal", "Near normal", "Above normal").

A string with the title of the legend showing the ensemble members. By default, it is set to "Ensemble members".

A string with the title of the legend showing the observations ('obs'). By default, it is set to "Observations".

A vector of strings with the name of the observations, which correspond to the values of 'obs'. By default, it is set to NULL.

A string with the title of the legend showing the extreme categories. By default, it is set to "Probability of extremes".

A vector of strings with the name of the extreme categories. By default, it is set to c("Below p10", "Above p90").

A string with the title of the x-axis. By default, it is set to "Probability density".

(optional) A string or vector of strings with the titles of each individual forecast panel.

A number with the size of 'toptitle'. By default, it is set to 1.

A number with the size of the labels in the axes. By default, it is set to 1.

A number with the size of the 'fcst.names'. By default, it is set to 1.

A logical value indicating whether to draw horizontal lines at the height of the observations. The default value is TRUE.

A number with the size of the observation dots. By default, it is set to 3.

Either to add the ensemble members 'above' (default) or 'below' the pdf, or not ('no').

A selection of predefined color sets: use 'ggplot' (default) for blue/green/red, 's2s4e' for blue/grey/orange, 'hydro' for yellow/gray/blue (suitable for precipitation and inflows) or the "vitigeoss" color set.

A character string indicating the name of the member dimension.

File width, in the units specified in the parameter size_units (inches by default). Takes 8 by default.

File height, in the units specified in the parameter size_units (inches by default). Takes 5 by default.

(optional) A filename (pdf, png...) where the plot will be saved. (Default: the plot is not saved).

Deprecated. Use 'fileout' instead.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Plot function (or name of the function) to be called on the arrays provided in 'data'. If multiple arrays are provided in 'data', a vector of as many function names (character strings!) can be provided in 'fun', one for each array in 'data'.

Numeric or character string vector with identifiers of the input plot dimensions of the plot function specified in 'fun'. If character labels are provided, names(dim(data)) or attr('dimensions', data) will be checked to locate the dimensions. As many plots as prod(dim(data)[-plot_dims]) will be generated. If multiple arrays are provided in 'data', 'plot_dims' can be sent a list with a vector of plot dimensions for each. If a single vector is provided, it will be used for all the arrays in 'data'.

Multi-dimensional array with at least the dimensions expected by the specified plot function in 'fun'. The dimensions reqired by the function must be specified in 'plot_dims'. The dimensions can be disordered and will be reordered automatically. Dimensions can optionally be labelled in order to refer to them with names in 'plot_dims'. All the available plottable sub-arrays will be automatically plotted and arranged in consecutive cells of an automatically arranged layout. A list of multiple (super-)arrays can be specified. The process will be repeated for each of them, by default applying the same plot function to all of them or, if properly specified in 'fun', a different plot function will be applied to each of them. NAs can be passed to the list: a NA will yield a blank cell in the layout, which can be populated after (see .SwitchToFigure).

Parameters to be sent to the plotting function 'fun'. If multiple arrays are provided in 'data' and multiple functions are provided in 'fun', the parameters provided through ... will be sent to all the plot functions, as common parameters. To specify concrete arguments for each of the plot functions see parameter 'special_args'.

List of sub-lists, each sub-list having specific extra arguments for each of the plot functions provided in 'fun'. If you want to fix a different value for each plot in the layout you can do so by a) splitting your array into a list of sub-arrays (each with the data for one plot) and providing it as parameter 'data', b) providing a list of named sub-lists in 'special_args', where the names of each sub-list match the names of the parameters to be adjusted, and each value in a sub-list contains the value of the corresponding parameter. For example, if the plots are two maps with different arguments, the structure would be like:
data:
List of 2
$ : num [1:360, 1:181] 1 3.82 5.02 6.63 8.72 ...
$ : num [1:360, 1:181] 2.27 2.82 4.82 7.7 10.32 ...
special_args:
List of 2
$ :List of 2
..$ arg1: ...
..$ arg2: ...
$ :List of 1
..$ arg1: ...

Numeric value to force the number of rows in the automatically generated layout. If higher than the required, this will yield blank cells in the layout (which can then be populated). If lower than the required the function will stop. By default it is configured to arrange the layout in a shape as square as possible. Blank cells can be manually populated after with customized plots (see SwitchTofigure).

Numeric value to force the number of columns in the automatically generated layout. If higher than the required, this will yield blank cells in the layout (which can then be populated). If lower than the required the function will stop. By default it is configured to arrange the layout in a shape as square as possible. Blank cells can be manually populated after with customized plots (see SwitchTofigure).

Topt title for the multi-pannel. Blank by default.

Character string vector with titles for each of the rows in the layout. Blank by default.

Character string vector with titles for each of the columns in the layout. Blank by default.

Scale factor for the common colour bar. Takes 1 by default.

Scale factor for the multi-pannel title. Takes 1 by default.

Scale factor for the margins surrounding the top title. Takes 1 by default.

When plotting row titles, a shift is added to the horizontal positioning of the top title in order to center it to the region of the figures (without taking row titles into account). This shift can be reduced. A value of 0 will remove the shift completely, centering the title to the total width of the device. This parameter will be disregarded if no 'row_titles' are provided.

Scale factor for the row titles and column titles (specified in 'row_titles' and 'col_titles'). Takes 1 by default.

Scale factor for the margins surrounding the subtitles. Takes 1 by default.

Scale factor for the subplots top titles. Takes 1 by default.

Usually only providing 'brks' is enough to generate the desired colour bar. These parameters allow to define n breaks that define n - 1 intervals to classify each of the values in 'data'. The corresponding grid cell of a given value in 'data' will be coloured in function of the interval it belongs to. These parameters are sent to ColorBarContinuous() to generate the breaks and colours. Additional colours for values beyond the limits of the colour bar are also generated and applied to the plot if 'bar_limits' or 'brks' and 'triangle_ends' are properly provided to do so. See ?ColorBarContinuous for a full explanation.

Where to draw the common colour bar. Can take values TRUE, FALSE or:
'up', 'u', 'U', 'top', 't', 'T', 'north', 'n', 'N'
'down', 'd', 'D', 'bottom', 'b', 'B', 'south', 's', 'S' (default)
'right', 'r', 'R', 'east', 'e', 'E'
'left', 'l', 'L', 'west', 'w', 'W'

Character string vector with titles for each of the figures in the multi-pannel, from top-left to bottom-right. Blank by default.

Colour identifiers to colour the values in 'data' that go beyond the extremes of the colour bar and to colour NA values, respectively. 'colNA' takes 'white' by default. 'col_inf' and 'col_sup' will take the value of 'colNA' if not specified. See ?ColorBarContinuous for a full explanation on 'col_inf' and 'col_sup'.

Set of parameters to control the visual aspect of the drawn colour bar. See ?ColorBarContinuous for a full explanation.

Title at the top of the colour bar, most commonly the units of the variable provided in parameter 'data'.

When plotting row titles, a shift is added to the horizontal positioning of the colour bar in order to center it to the region of the figures (without taking row titles into account). This shift can be reduced. A value of 0 will remove the shift completely, centering the colour bar to the total width of the device. This parameter will be disregarded if no 'row_titles' are provided.

Extra margins to be added around the layout, in the format c(y1, x1, y2, x2). The units are margin lines. Takes rep(0, 4) by default.

Logical indicating wether the panels should be filled by columns (FALSE) or by rows (TRUE, default).

File where to save the plot. If not specified (default) a graphics device will pop up. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff.

Width in inches of the multi-pannel. 7 by default, or 11 if 'fielout' has been specified.

Height in inches of the multi-pannel. 7 by default, or 11 if 'fileout' has been specified.

Units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Whether to close the graphics device after plotting the layout and a 'fileout' has been specified. This is useful to avoid closing the device when saving the layout into a file and willing to add extra elements or figures. Takes TRUE by default. Disregarded if no 'fileout' has been specified.

Deprecated. Use 'data' instead.

Breaks used for colouring the map (and legend if drawleg = TRUE).

Colours used for colouring the map (and legend if drawleg = TRUE). Always of length length(brks) - 1.

Colour used to draw the lower triangle end in the colour bar (NULL if not drawn at all).

Colour used to draw the upper triangle end in the colour bar (NULL if not drawn at all).

Underlying matrix of the layout. Useful to later set any of the layout cells as current figure to add plot elements. See .SwitchToFigure.

A numerical matrix containing the values to be displayed in a colored image.

A vector of the color bar intervals. The length must be one more than the parameter 'cols'. Use ColorBarContinuous() to generate default values.

A vector of valid color identifiers for color bar. The length must be one less than the parameter 'brks'. Use ColorBarContinuous() to generate default values.

A string of the title of the grid. Set NULL as default.

A string of valid color identifier to decide the title color. Set "royalblue4" as default.

A string of title of the x-axis. Set NULL as default.

A string of title of the y-axis. Set NULL as default.

A vector of labels of the x-axis. The length must be length of the column of parameter 'data'. Set the sequence from 1 to the length of the column of parameter 'data' as default.

A logical value to decide whether to place x-axis labels vertically. Set FALSE as default, which keeps the labels horizontally.

A vector of labels of the y-axis The length must be length of the row of parameter 'data'. Set the sequence from 1 to the length of the row of parameter 'data' as default.

An integer specifying the distance between the title of the x-axis and the x-axis. Set 3 as default. Adjust if the x-axis labels are long.

A positive number as a ratio adjusting the width of the grids. Set 1 as default.

A logical value to decide to draw the grid color legend or not. Set TRUE as default.

Deprecated. Use 'drawleg' instead.

A number between 0 and 0.5 to adjust the legend width. Set 0.15 as default.

A number specifying the distance between the x labels and the x axis. If not specified, it equals to -1 - (nrow(data) / 10 - 1).

A number specifying the distance between the y labels and the y axis. If not specified, it equals to 0.5 - ncol(data) / 10.

A string of full directory path and file name indicating where to save the plot. If not specified (default), a graphics device will pop up.

A string indicating the units of the size of the device (file or window) to plot in. Set 'px' as default. See ?Devices and the creator function of the corresponding device.

A positive number indicating resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Deprecated. Use 'data' instead.

The additional parameters to be passed to function ColorBarContinuous() in s2dv for color legend creation.

A list of bi-dimensional arrays with the named dimensions 'latitude' (or 'lat') and 'longitude' (or 'lon'), with equal size and in the same order, or a single tri-dimensional array with an additional dimension (e.g. 'bin') for the different categories. The arrays must contain probability values between 0 and 1, and the probabilities for all categories of a grid cell should not exceed 1 when added.

A numeric vector with the longitudes of the map grid, in the same order as the values along the corresponding dimension in probs.

A numeric vector with the latitudes of the map grid, in the same order as the values along the corresponding dimension in probs.

The name of the dimension along which the different categories are stored in probs. This only applies if probs is provided in the form of 3-dimensional array. The default expected name is 'bin'.

Vector of character strings with the names to be drawn on top of the color bar for each of the categories. As many titles as categories provided in probs must be provided.

Character string with a colour representation of the colour to be used to paint the cells for which no category can be clearly assigned. Takes the value 'white' by default.

Where to draw the common colour bar. Can take values TRUE, FALSE or:
'up', 'u', 'U', 'top', 't', 'T', 'north', 'n', 'N'
'down', 'd', 'D', 'bottom', 'b', 'B', 'south', 's', 'S' (default)
'right', 'r', 'R', 'east', 'e', 'E'
'left', 'l', 'L', 'west', 'w', 'W'

Numeric vector of length 4 specifying the plot margins (excluding the color bar), in the order: bottom, left, top, and right. If not specified (NULL), the default margins from par("mar"), which are c(5.1, 4.1, 4.1, 2.1), are used. Default is NULL.

Numeric vector of length 4 specifying the margins to be added around the color bar, in the order: bottom, left, top, and right. The units are margin lines. The default values are c(1.5, 0, 1.5, 0).

Additional parameters to be sent to VizCombinedMap and VizEquiMap.

A numeric array with a dimension named 'statistic', containg two parameters: mean' and 'standard deviation' of the first gaussian pdf to combining.

A numeric array with a dimension named 'statistic', containg two parameters: mean' and 'standard deviation' of the second gaussian pdf to combining.

(optional) A numeric value for setting the limits of X axis. (Default nsigma = 3).

(optional) A character value for setting the position of the legend ("bottom", "top", "right" or "left")(Default 'bottom').

(optional) A numeric value for setting the size of the legend text. (Default 1.0).

(optional) A filename where the plot will be saved. (Default: the plot is not saved).

Deprecated. Use 'fileout' instead

(optional) A numeric value indicating the plot width in units ("in", "cm", or "mm"). (Default width = 30).

(optional) A numeric value indicating the plot height. (Default height = 15).

(optional) A character value indicating the plot size unit. (Default units = 'cm').

(optional) A numeric value indicating the plot resolution. (Default dpi = 300).

A numeric array with longitude and latitude dimensions. The grid should be regular grid. It can contain NA values.

A numeric vector of longitude locations of the cell centers of the grid of 'data'. Expected to be regularly spaced, within the range of either [-180, 180] or [0, 360].

A numeric vector of latitude locations of the cell centers of the grid of 'data'. Expected to be regularly spaced, within the range [-90, 90] of ascending or descending order.

A character string indicating the longitude dimension name in 'data'. If it is NULL, the function tries to find the name in esviz:::.KnownLonNames. The default value is NULL.

A character string indicating the latitude dimension name in 'data'. If it is NULL, the function tries to find the name in esviz:::.KnownLatNames. The default value is NULL.

A character string indicating the target projection. It should be a valid crs string. The default projection is Robinson: "ESRI:54030". Note that the character string may work differently depending on PROJ and GDAL module version. If package version 'sf' is lower than "1.0.10" and an error appears regarding the target crs, you can try with numeric crs (e.g. target_proj = 54030).

A character string indicating the legend style. It can be 'bar' (color bar by ColorBarContinuous()), 'ggplot2' (discrete legend by ggplot2), or FALSE (no legend). The default value is 'bar'.

A character string indicating the plotting style. It can be 'point' or 'polygon'. The default value is 'point'. Note that 'polygon' may be time- and memory-consuming for global or high-resolution data.

An array with the same dimensions as 'data' of [0, 1] or logical indicating the grids to plot dots. The value 0 or FALSE is the point to be dotted.

An array with the same dimensions as 'data' of [0, 1] or logical indicating the grids to not plot data. The value 0 or FALSE is the point not to be plotted.

Usually only providing 'brks' is enough to generate the desired color bar. These parameters allow to define n breaks that define n - 1 intervals to classify each of the values in 'data'. The corresponding grid cell of a given value in 'data' will be colored in function of the interval it belongs to. These parameters are sent to ColorBarContinuous() to generate the breaks and colours. Additional colors for values beyond the limits of the colour bar are also generated and applied to the plot if 'bar_limits' or 'brks' and 'triangle_ends' are properly provided to do so. See ?ColorBarContinuous for a full explanation.

Colour identifiers to color the values that excess the extremes of the color bar and to color NAs, respectively. 'colNA' takes attr(cols, 'na_color') if available by default, where cols is the parameter 'cols' if provided or the vector of colors returned by 'color_fun'. 'col_inf' and 'col_sup' will take the value of 'colNA' if not specified. See ?ColorBarContinuous for a full explanation.

Set of parameters to control the visual aspect of the drawn colour bar (1/3). See ?ColorBarContinuous for a full explanation.

A logical value indicating the direction of colorbar if parameter 'drawleg' is 'bar'. The default value is TRUE.

A character string of the top title of the figure, scalable with parameter 'title_scale'.

A character string of the caption located at left-bottom of the plot.

A character string of the data units, which is the title of the legend.

A named numeric vector [lonmin, lonmax, latmin, latmax] indicating the region to plot coastlines. Note that the longitude range cannot exceed 180 degrees.

A number of the size of the data points if "style = 'point'". The default is 'auto' and the function tries to find the appropriate size.

A number of the size of the top title. The default is 16.

Deprecated. Use 'title_scale' instead.

A number of the size of the dots. The default is 0.5.

Deprecated. Use 'dot_size' instead.

A number indicating the dot shape recognized by parameter 'shape' in geom_point().

Deprecated. Use 'dot_symbol' instead.

A number indicating the width of the coastlines. Default is 0.3.

Deprecated. Use 'coast_width' instead.

A character string of the path to save the plot. If not specified (default), a graphic device will pop up. The extension should be accepted by ggsave().

A number of the plot width, in the units specified in parameter 'size_units'. The default is 8.

A number of the plot height, in the units specified in parameter 'size_units'. The default is 4.

A character string of the units of the size of the device (file or window) to plot in. The default is 'in' (inches). See ?ggsave and ?Devices for details of the corresponding device.

Resolution of the device (file or window) to plot in. The default value is 300. See ?ggsave 'dpi' and ?Devices for details of the corresponding device.

A multidimensional array containing the data to be plotted with at least four dimensions. Each dimension will have assigned a structure element: row, subrow, column and subcolumn.

A multidimensional boolean array with the same dimensions as 'data', indicting which values to be highlighted. If set to NULL no values will be highlighted.

A character string indicating the dimension name to show in the rows of the plot. It is set as 'region' by default.

A character string indicating the dimension name to show in the sub-rows of the plot. It is set as 'time' by default.

A character string indicating the dimension name to show in the columns of the plot. It is set as 'metric' by default.

A character string indicating the dimension name to show in the sub-columns of the plot. It is set as 'sdate' by default.

A character string indicating the dimension name to use for the legend. It is set as 'metric' by default.

A vector of character strings with row display names. It is set as NULL by default.

A vector of character strings with sub-row display names. It is set as NULL by default.

A vector of character strings with column display names. It is set as NULL by default.

A vector of character strings with sub-column display names. It is set as NULL by default.

A character string for the title of the row names. It is set as NULL by default.

A character string for the title of the sub-row names. It is set as NULL by default.

A character string for the title of the column names. It is set as NULL by default.

A character string for the title of the plot. It is set as NULL by default.

A character string for the sub-title of the plot. It is set as NULL by default.

A vector of numerics or a list of vectors of numerics, containing the breaks for the legends. If a vector is given as input, then these breaks will be repeated for each 'legend_dim'. A list of vectors can be given as input if the 'legend_dims' require different breaks. This parameter is required even if the legend is not plotted, to define the colors in the scorecard table. It is set as NULL by default.

A logical value to determine if the legend is plotted. It is set as TRUE by default.

A numeric value to define the size of the legend labels. It is set as 1.4 by default.

A numeric value to define the width of the legend bars. By default it is set to NULL and calculated internally from the table width.

A numeric value to define the height of the legend bars. It is set as 50 by default.

A vector of character strings or a list of vectors of character strings containing the colors to use in the legends. If a vector is given as input, then these colors will be used for each legend_dim. A list of vectors can be given as input if different colors are desired for the legend_dims. This parameter must be included even if the legend is not plotted, to define the colors in the scorecard table.

A character string, a vector of character strings or a list with single character string elements defining the colors to use for data values with are inferior to the lowest breaks value. This parameter will also plot a inferior triangle in the legend bar. The parameter can be set to NULL if there are no inferior values. If a character string is given this color will be applied to all 'legend_dims'. It is set as NULL by default.

A character string, a vector of character strings or a list with single character string elements defining the colors to use for data values with are superior to the highest breaks value. This parameter will also plot a inferior triangle in the legend bar. The parameter can be set to NULL if there are no superior values. If a character string is given this color will be applied to all legend_dims. It is set as NULL by default.

A numeric indicating to which decimal point the data is to be displayed in the scorecard table. It is set as 2 by default.

A numeric indicating the font size on the scorecard table. Default is 2.

A numeric value defining the initial starting position of the legend bars, the white space infront of the legend is calculated from the left most point of the table as a distance in cm. The default value is 6.

A numeric value defining the width all columns within the table in cm (excluding the first and second columns containing the titles).

A numeric value defining the width of the first table column in cm. It is set as NULL by default.

A numeric value defining the width of the second table column in cm. It is set as NULL by default.

A path of the location to save the scorecard plots. By default the plots will be saved to the working directory.

Matrix to plot with (longitude/latitude, depth) dimensions.

Array of longitudes or latitudes.

Array of depths.

Title, optional.

Scale factor for the figure top title. Defaults to 1.

Deprecated. Use 'title_scale' instead.

Units, optional.

Colour levels, optional.

List of colours, optional.

TRUE/FALSE, label the axis. Default = TRUE.

Interval between depth ticks on y-axis. Default: 200m.

Interval between longitude/latitude ticks on x-axis.
Default: 20deg.

Draw colorbar. Default: TRUE.

Name of output file. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff.
Default = NULL

File width, in the units specified in the parameter size_units (inches by default). Takes 8 by default.

File height, in the units specified in the parameter size_units (inches by default). Takes 5 by default.

Units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Deprecated. Use 'data' instead.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bg bty cex.lab cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg fig fin font font.axis font.lab font.main font.sub lend lheight ljoin lmitre lty lwd mex mfcol mfrow mfg mkh oma omd omi page pch pin plt pty smo srt tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog
For more information about the parameters see 'par'.

Array with the values at each cell of a grid on a regular rectangular or gaussian grid. The array is expected to have two dimensions: c(latitude, longitude). Longitudes can be in ascending or descending order and latitudes in any order. It can contain NA values (coloured with 'colNA'). Arrays with dimensions c(longitude, latitude) will also be accepted but 'lon' and 'lat' will be used to disambiguate so this alternative is not appropriate for square arrays.

Numeric vector of longitude locations of the cell centers of the grid of 'data', in ascending or descending order (same as 'data'). Expected to be regularly spaced, within either of the ranges [-180, 180] or [0, 360]. Data for two adjacent regions split by the limits of the longitude range can also be provided, e.g. lon = c(0:50, 300:360) ('data' must be provided consitently).

Numeric vector of latitude locations of the cell centers of the grid of 'data', in any order (same as 'data'). Expected to be from a regular rectangular or gaussian grid, within the range [-90, 90].

Array of the zonal component of wind/current/other field with the same dimensions as 'data'.

Array of the meridional component of wind/current/other field with the same dimensions as 'data'.

Latitudinal limits of the figure.
Example : c(60, 90) for the North Pole
c(-90,-60) for the South Pole

Top title of the figure, scalable with parameter 'title_scale'.

Scale factor for the figure top title provided in parameter 'toptitle'. Deprecated. Use 'title_scale' instead.

Title at the top of the colour bar, most commonly the units of the variable provided in parameter 'data'.

Usually only providing 'brks' is enough to generate the desired colour bar. These parameters allow to define n breaks that define n - 1 intervals to classify each of the values in 'data'. The corresponding grid cell of a given value in 'data' will be coloured in function of the interval it belongs to. These parameters are sent to ColorBarContinuous() to generate the breaks and colours. Additional colours for values beyond the limits of the colour bar are also generated and applied to the plot if 'bar_limits' or 'brks' and 'triangle_ends' are properly provided to do so. See ?ColorBarContinuous for a full explanation.

Colour identifiers to colour the values in 'data' that go beyond the extremes of the colour bar and to colour NA values, respectively. 'colNA' takes attr(cols, 'na_color') if available by default, where cols is the parameter 'cols' if provided or the vector of colors returned by 'color_fun'. If not available, it takes 'pink' by default. 'col_inf' and 'col_sup' will take the value of 'colNA' if not specified. See ?ColorBarContinuous for a full explanation on 'col_inf' and 'col_sup'.

Set of parameters to control the visual aspect of the drawn colour bar. See ?ColorBarContinuous for a full explanation.

Colour to fill in drawn projected continents. Takes the value gray(0.5) by default. If set to FALSE, continents are not filled in.

Colour of the coast line of the drawn projected continents. Takes the value gray(0.5) by default.

Line width of the coast line of the drawn projected continents. Takes the value 1 by default.

Array of same dimensions as 'data' to be added to the plot and displayed with contours. Parameter 'brks2' is required to define the magnitude breaks for each contour curve.

A numeric value or vector of magnitude breaks where to draw contour curves for the array provided in 'contours'. If it is a number, it represents the number of breaks (n) that defines (n - 1) intervals to classify 'contours'.

Line width of the contour curves provided via 'contours' and 'brks2'. The default value is 0.5.

Line color of the contour curves provided via 'contours' and 'brks2'.

Line type of the contour curves. Takes 1 (solid) by default. See help on 'lty' in par() for other accepted values.

A logical value indicating whether to draw the contour labels (TRUE) or not (FALSE) when 'contours' is used. The default value is TRUE.

Deprecated. Use 'contour_draw_label' instead.

Scale factor for the superimposed labels when drawing contour levels. The default value is 0.6.

Array of same dimensions as 'data' or with dimensions c(n, dim(data)), where n is the number of dot/symbol layers to add to the plot. A value of TRUE at a grid cell will draw a dot/symbol on the corresponding square of the plot. By default all layers provided in 'dots' are plotted with dots, but a symbol can be specified for each of the layers via the parameter 'dot_symbol'.

Single character/number or vector of characters/numbers that correspond to each of the symbol layers specified in parameter 'dots'. If a single value is specified, it will be applied to all the layers in 'dots'. Takes 15 (centered square) by default. See 'pch' in par() for additional accepted options.

Scale factor for the dots/symbols to be plotted, specified in 'dots'. If a single value is specified, it will be applied to all layers in 'dots'. Takes 1 by default.

Interval between latitude lines (circles), in degrees. Defaults to 10.

A number as subsampling factor to select a subset of arrows in 'varu' and 'varv' to be drawn. Only one out of arr_subsamp arrows will be drawn. The default value is 1.

A number as scale factor for drawn arrows from 'varu' and 'varv'. The default value is 1.

A number of the length of the refence arrow to be drawn as legend at the bottom of the figure (in same units as 'varu' and 'varv', only affects the legend for the wind or variable in these arrays). The default value is 15.

Units of 'varu' and 'varv', to be drawn in the legend. Takes 'm/s' by default.

A number for the scale of the shaft of the arrows (which also depend on the number of figures and the arr_scale parameter). The default value is 1.

A number for the scale of the angle of the shaft of the arrows (which also depend on the number of figure and the arr_scale parameter). The default value is 1.

Whether to plot a color bar (legend, key) or not. Defaults to TRUE.

Limits of a box to be added to the plot, in degrees: c(x1, y1, x2, y2). A list with multiple box specifications can also be provided.

Colour of the box lines. A vector with a colour for each of the boxes is also accepted. Defaults to 'purple2'.

Line width of the box lines. A vector with a line width for each of the boxes is also accepted. Defaults to 5.

Scale factor for the margins to be added to the plot, with the format c(y1, x1, y2, x2). Defaults to rep(1, 4). If drawleg = TRUE, margin_scale[1] is subtracted 1 unit.

Scale factor for the figure top title. Defaults to 1.

Number of figures in the layout the plot will be put into. A higher numbfig will result in narrower margins and smaller labels, axe labels, ticks, thinner lines, ... Defaults to 1.

File where to save the plot. If not specified (default) a graphics device will pop up. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff.

File width, in the units specified in the parameter size_units (inches by default). Takes 8 by default.

File height, in the units specified in the parameter size_units (inches by default). Takes 5 by default.

Units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Deprecated. Use 'data' instead.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bg bty cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg font font.axis font.lab font.main font.sub lend lheight ljoin lmitre mex mfcol mfrow mfg mkh omd omi page pch pin plt pty smo srt tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog
For more information about the parameters see 'par'.

Breaks used for colouring the map (and legend if drawleg = TRUE).

Colours used for colouring the map (and legend if drawleg = TRUE). Always of length length(brks) - 1.

Colour used to draw the lower triangle end in the colour bar (NULL if not drawn at all).

Colour used to draw the upper triangle end in the colour bar (NULL if not drawn at all).

Array with three named dimensions: 'dimx', 'dimy', 'dimcat', containing the values to be displayed in a coloured image with triangles.

A vector of the color bar intervals. The length must be one more than the parameter 'cols'. Use ColorBar() to generate default values.

A vector of valid colour identifiers for color bar. The length must be one less than the parameter 'brks'. Use ColorBar() to generate default values.

A string of the title of the grid. Set NULL as default.

Logical array with the same dimensions as 'data' to add layers to the plot. A value of TRUE at a grid cell will draw a dot/symbol on the corresponding triangle of the plot. Set NULL as default.

Symbol to be used to represent sig_data. Takes 18 (diamond) by default. See 'pch' in par() for additional accepted options.

Colour of the symbol to represent sig_data.

Parameter to increase/reduce the size of the symbols used to represent sig_data.

A logical value (TRUE) indicating if xlabels should be plotted

A logical value (TRUE) indicating if ylabels should be plotted

A vector of labels of the x-axis The length must be length of the col of parameter 'data'. Set the sequence from 1 to the length of the row of parameter 'data' as default.

A string of title of the x-axis. Set NULL as default.

A vector of labels of the y-axis The length must be length of the row of parameter 'data'. Set the sequence from 1 to the length of the row of parameter 'data' as default.

A string of title of the y-axis. Set NULL as default.

A logical value to decide to draw the color bar legend or not. Set TRUE as default.

Deprecated. Use 'drawleg' instead.

A vector of labels indicating what is represented in each category (i.e. triangle). Set the sequence from 1 to the length of the categories (2 or 4).

A number to indicate the increase/reductuion of the lab_legend used to represent sig_data.

Color of the legend (triangles).

A number to indicate the increase/reduction of the axis labels.

A numerical vector of the form c(bottom, left, top, right) which gives the number of lines of margin to be specified on the four sides of the plot.

A string of full directory path and file name indicating where to save the plot. If not specified (default), a graphics device will pop up.

A string indicating the units of the size of the device (file or window) to plot in. Set 'px' as default. See ?Devices and the creator function of the corresponding device.

A positive number indicating resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

a numeric value to control the width of the plot.

The additional parameters to be passed to function ColorBarContinuous() in for color legend creation.

Matrix containing any Prediction Score with dimensions:
(nexp/nmod, 3/4 ,nltime)
or (nexp/nmod, nobs, 3/4 ,nltime).

Main title, optional.

Title of Y-axis, optional.

Starting month between 1 and 12. Default = 1.

1 = yearly, 12 = monthly, 4 = seasonal, ... Default = 12.

Number of ticks and labels on the x-axis, optional.

c(lower limit, upper limit): limits of the Y-axis, optional.

List of experiment names, optional.

List of observation names, optional.

TRUE/FALSE for presentation/paper plot. Default = FALSE.

c(a,b, ..) Add horizontal black lines at Y-positions a,b, ...
Default = NULL.

TRUE/FALSE if legend should be added or not to the plot. Default = TRUE.

Deprecated. Use 'drawleg' instead.

TRUE/FALSE if significance level should replace confidence interval.
Default = FALSE.

Scale factor for the figure top title. Defaults to 1.

Deprecated. Use 'title_scale' instead.

TRUE/FALSE to show/not confidence intervals for input variables.

Name of output file. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff. The default value is NULL.

File width, in the units specified in the parameter size_units (inches by default). Takes 8 by default.

File height, in the units specified in the parameter size_units (inches by default). Takes 5 by default.

Units of the size of the device (file or window) to plot in. Inches ('in') by default. See ?Devices and the creator function of the corresponding device.

Resolution of the device (file or window) to plot in. See ?Devices and the creator function of the corresponding device.

Deprecated. Use 'data' instead.

Arguments to be passed to the method. Only accepts the following graphical parameters:
adj ann ask bg bty cex.sub cin col.axis col.lab col.main col.sub cra crt csi cxy err family fg fig font font.axis font.lab font.main font.sub lheight ljoin lmitre mar mex mfcol mfrow mfg mkh oma omd omi page pch plt smo srt tck tcl usr xaxp xaxs xaxt xlog xpd yaxp yaxs yaxt ylbias ylog
For more information about the parameters see 'par'.

A multidimensional array with named start date and lead time dimensions; if other dimensions are found, the function drops them with the first index. It can also be a dataframe with computed percentiles as input for ggplot. If it's a dataframe, it must contain the following column names: 'week', 'clim', 'p10', 'p90', 'p33', 'p66', 'week_mean', 'day' and 'data'.

The first date of the observed values of timeseries. It can be of class 'Date', 'POSIXct' or a character string in the format 'yyyy-mm-dd'. If parameter 'data_years' is not provided, it must be a date included in the reference period.

A vector of numeric values indicating the years of the reference period. If parameter 'data_years' is not specified, it must be of the same length of dimension 'sdate_dim' of parameter 'data'.

Optional parameter indicating the last date of the target period of the daily timeseries. It can be of class 'Date', 'POSIXct' or a character string in the format 'yyyy-mm-dd'. If it is NULL, the last date of the daily timeseries will be set as the last date of 'data'. As the data is plotted by weeks, only full groups of 7 days will be plotted. If the last date of the timeseries is not a multiple of 7 days, the last week will not be plotted.

A vector of numeric values indicating the years of the data. It must be of the same length of dimension 'sdate_dim' of parameter 'data'. It is optional, if not specified, all the years will be used as the target period.

A character string indicating the daily time dimension name. The default value is 'time'.

A character string indicating the start year dimension name. The default value is 'sdate'.

A numeric vector of length two providing limits of the scale. Use NA to refer to the existing minimum or maximum. For more information, see 'ggplot2' documentation of 'scale_y_continuous' parameter.

The text for the top title of the plot. It is NULL by default.

Deprecated. Use 'toptitle' instead.

The text for the subtitle of the plot. It is NULL bu default.

Character string to be drawn as y-axis title. It is NULL by default.

A logical value indicating whether a legend should be included in the plot. If it is TRUE or NA, the legend will be included. If it is FALSE, the legend will not be included. It is TRUE by default.

A palette name from the R Color Brewer’s package. The default value is 'Blues'.

A character string indicating the file name where to save the plot. If not specified (default) a graphics device will pop up.

A character string indicating the device to use. Can either be a device function (e.g. png), or one of "eps", "ps", "tex" (pictex), "pdf", "jpeg", "tiff", "png", "bmp", "svg" or "wmf" (windows only).

A numeric value of the plot width in units ("in", "cm", "mm", or "px"). It is set to 8 by default.

A numeric value of the plot height in units ("in", "cm", "mm", or "px"). It is set to 6 by default.

Units of the size of the device (file or window) to plot in. Inches (’in’) by default.

A numeric value of the plot resolution. It is set to 300 by default.