plot_scx: Illustrate the observational constraint

View source: R/plot.R

plot_scxR Documentation

Illustrate the observational constraint

Description

Illustrate the observational constraint

Usage

plot_scx(X_Cons, obs_x, ofile, ref_plot = NULL, event = NA, ylim = NULL)

Arguments

X_Cons

a 3-D array of dimension [length(year),Nres+1,c("uncons","cons")] containing time series sampling the prior and posterior distributions. The first dimension has the time series of years, year, as names. The second dimension corresponds to the number of realisations sampling the distribution ; the first realisation is the best-estimate. For the third dimension, "uncons" ("cons") refers to the unconstrained (constrained) distribution.

obs_x

a vector of observations.

ofile

a character giving the name of the file in which graphics are saved

ref_plot

a vector containing the years corresponding to the reference period to plot anomalies. If NULL, raw values are plotted.

event

a numeric value indicating a year corresponding to an event plotted as a vertical line

ylim

a vector of two numeric values indicating the limits along the y-axis. If NULL a range is computed automatically.

Value

A detrended time series


saidqasmi/KCC documentation built on July 8, 2022, 6:02 a.m.