s2dverification: PlotACC – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

PlotACC

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

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

Arguments

`ACC`	ACC matrix 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`	List of startdates: c('YYYYMMDD','YYYYMMDD').
`toptitle`	Main title, optional.
`sizetit`	Multiplicative factor to scale title size, optional.
`ytitle`	Title of Y-axis for each experiment: c(”,”), optional.
`limits`	c(lower limit, upper limit): limits of the Y-axis, optional.
`legends`	List of flags (characters) to be written in the legend, optional.
`freq`	1 = yearly, 12 = monthly, 4 = seasonal, ... Default: 12.
`biglab`	TRUE/FALSE for presentation/paper plot, Default = FALSE.
`fill`	TRUE/FALSE if filled confidence interval. Default = FALSE.
`linezero`	TRUE/FALSE if a line at y=0 should be added. Default = FALSE.
`points`	TRUE/FALSE if points instead of lines. Default = TRUE. Must be TRUE if only 1 leadtime.
`vlines`	List of x location where to add vertical black lines, optional.
`fileout`	Name of output file. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff. Default = 'output_PlotACC.eps'
`width`	File width, in the units specified in the parameter size_units (inches by default). Takes 8 by default.
`height`	File height, in the units specified in the parameter size_units (inches by default). Takes 5 by default.
`size_units`	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'.

Author(s)

History:
0.1 - 2013-08 (V. Guemas, virginie.guemas@ic3.cat) - Original code
1.0 - 2013-09 (N. Manubens, nicolau.manubens@ic3.cat) - Formatting to CRAN

Examples

# See examples on Load() to understand the first lines in this example
 ## Not run: 
data_path <- system.file('sample_data', package = 's2dverification')
expA <- list(name = 'experiment', path = file.path(data_path,
            'model/$EXP_NAME$/$STORE_FREQ$_mean/$VAR_NAME$_3hourly',
            '$VAR_NAME$_$START_DATE$.nc'))
obsX <- list(name = 'observation', path = file.path(data_path,
            '$OBS_NAME$/$STORE_FREQ$_mean/$VAR_NAME$',
            '$VAR_NAME$_$YEAR$$MONTH$.nc'))

# Now we are ready to use Load().
startDates <- c('19851101', '19901101', '19951101', '20001101', '20051101')
sampleData <- Load('tos', list(expA), list(obsX), startDates,
                  leadtimemin = 1, leadtimemax = 4, output = 'lonlat',
                  latmin = 27, latmax = 48, lonmin = -12, lonmax = 40)
 
## End(Not run)
 
sampleData$mod <- Season(sampleData$mod, 4, 11, 12, 2)
sampleData$obs <- Season(sampleData$obs, 4, 11, 12, 2)
clim <- Clim(sampleData$mod, sampleData$obs)
ano_exp <- Ano(sampleData$mod, clim$clim_exp)
ano_obs <- Ano(sampleData$obs, clim$clim_obs)
acc <- ACC(Mean1Dim(sampleData$mod, 2), 
          Mean1Dim(sampleData$obs, 2))
 
PlotACC(acc$ACC, startDates, toptitle = "Anomaly Correlation Coefficient")

s2dverification

Set of Common Tools for Forecast Verification

v2.10.0

Apache License 2.0

Authors

BSC-CNS [aut, cph], Virginie Guemas [aut], Nicolau Manubens [aut], An-Chi Ho [ctb, cre], Nuria Perez-Zanon [ctb], Javier Garcia-Serrano [aut], Neven Fuckar [aut], Louis-Philippe Caron [aut], Omar Bellprat [aut], Luis Rodrigues [aut], Veronica Torralba [aut], Alasdair Hunter [aut], Chloe Prodhomme [aut], Martin Menegoz [aut], Domingo Manubens [ctb], Constantin Ardilouze [ctb], Lauriane Batte [ctb], Fabian Lienert [ctb], Julia Giner [ctb], Jean-Philippe Baudouin [ctb], Nube Gonzalez [ctb], Ludovic Auger [ctb], Nicola Cortesi [ctb], Eleftheria Exarchou [ctb], Ruben Cruz [ctb], Isabel Andreu-Burillo [ctb], Ramiro Saurral [ctb]

Initial release