esviz (version 0.0.2)

VizACC: Plot Plumes/Timeseries Of Anomaly Correlation Coefficients

Description

Plots plumes/timeseries of ACC from an array with dimensions (output from ACC()):
c(nexp, nobs, nsdates, nltime, 4)
where the fourth dimension is of length 4 and contains the lower limit of the 95% confidence interval, the ACC, the upper limit of the 95% confidence interval and the 95% significance level given by a one-sided T-test.

Usage

VizACC(
  ACC,
  sdates,
  toptitle = "",
  title_scale = 1,
  sizetit = NULL,
  ytitle = "",
  limits = NULL,
  legends = NULL,
  freq = 12,
  biglab = FALSE,
  fill = FALSE,
  linezero = FALSE,
  points = TRUE,
  vlines = NULL,
  fileout = NULL,
  width = 8,
  height = 5,
  size_units = "in",
  res = 100,
  ...
)

Value

A figure in popup window by default, or saved to the specified path via fileout.

Arguments

ACC

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.

sdates

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

toptitle

A character string of the main title, optional.

title_scale

A multiplicative factor to scale title size, optional.

sizetit

Deprecated. Use 'title_scale' instead.

ytitle

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

limits

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

legends

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

freq

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

biglab

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

fill

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

linezero

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

points

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

vlines

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

fileout

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

width

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

height

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

size_units

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.

res

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

Examples

ano <- s2dv::Ano_CrossValid(map_temp$exp, map_temp$obs, memb = FALSE, 
                            dat_dim = c('dat', 'member'), memb_dim = 'member')
lats <- attr(map_temp$exp, "Variables")$common$lat
lons <- attr(map_temp$exp, "Variables")$common$lon
acc <- s2dv::ACC(ano$exp, ano$obs, lat = lats, lon = lons,
                 dat_dim = 'dat', memb_dim = 'member')
input_acc <- array(dim = c(dim(acc$acc)[c('nexp', 'nobs', 'sdate', 'time')], 4))
input_acc[, , , , 1] <- acc$conf.lower
input_acc[, , , , 2] <- acc$acc
input_acc[, , , , 3] <- acc$conf.upper
input_acc[, , , , 4] <- acc$p.val
sdates <- paste0(2000:2005, '1101')
VizACC(input_acc, sdates, 
       toptitle = "Spatial anomaly corr. coeff. with ERA5",
       ytitle = "K", title_scale = 0.7, freq = 12,
       legends = 'SEAS5', fileout = NULL)