s2dv (version 0.0.1)

PlotClim: Plots Climatologies

Description

Plots climatologies as a function of the forecast time for any index output from Clim() and organized in matrix with dimensions: c(nmod/nexp, nmemb/nparam, nltime) or c(nmod/nexp, nltime) for the experiment data c(nobs, nmemb, nltime) or c(nobs, nltime) for the observational data

Usage

PlotClim(exp_clim, obs_clim = NULL, toptitle = "", ytitle = "",
  monini = 1, freq = 12, limits = NULL, listexp = c("exp1", "exp2",
  "exp3"), listobs = c("obs1", "obs2", "obs3"), biglab = FALSE,
  leg = TRUE, sizetit = 1, fileout = "output_plotclim.eps", width = 8,
  height = 5, size_units = "in", res = 100, ...)

Arguments

exp_clim

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

obs_clim

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

toptitle

Main title, optional.

ytitle

Title of Y-axis, optional.

monini

Starting month between 1 and 12. Default = 1.

freq

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

limits

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

listexp

List of experiment names, optional.

listobs

List of observational dataset names, optional.

biglab

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

leg

TRUE/FALSE to plot the legend or not.

sizetit

Multiplicative factor to scale title size, optional.

fileout

Name of output file. Extensions allowed: eps/ps, jpeg, png, pdf, bmp and tiff. Default = 'output_plotclim.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 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`.

Examples

# NOT RUN {
# Load sample data as in Load() example:
example(Load)
clim <- Clim(sampleData$mod, sampleData$obs)
tmpfile <- tempfile(tmpdir = tempdir(), fileext = ".eps")
PlotClim(clim$clim_exp, clim$clim_obs, toptitle = paste('climatologies'), 
        ytitle = 'K', monini = 11, listexp = c('CMIP5 IC3'), 
        listobs = c('ERSST'), biglab = FALSE, fileout = tmpfile)

# }