plotMonthlyTimeseriesWAnomalyBar: Plot monthly timeseries with anomaly bar

plotMonthlyTimeseriesWAnomalyBarR Documentation

Plot monthly timeseries with anomaly bar

Description

Creates a time series plot with the monthly anomaly and annual anomaly scorecard below.

Usage

plotMonthlyTimeseriesWAnomalyBar(
  xYear,
  xMonth,
  y,
  yAnomaly,
  yNormalizedAnomaly,
  xAnnualAnomaly,
  yAnnualAnomaly,
  plotAnnual = TRUE,
  xClimatology,
  yClimatology,
  sdClimatology,
  xlim,
  ylim,
  anomalyColors,
  scorecardSeparation = par("cin")[2]/2 + 0.1 - 0.05 - 0.0125,
  scorecardWidth = par("cin")[2] + 0.2 - 0.05 - 0.0125
)

Arguments

xYear

a numeric vector of the associated year

xMonth

a numeric vector of the associated month

y

a numeric vector of the associated year month value

yAnomaly

a numeric vector of the associated anomaly year month value

yNormalizedAnomaly

a numeric vector of the associated normalized anomaly with xYear and xMonth

xAnnualAnomaly

a numeric vector of the year for the annual anomaly

yAnnualAnomaly

a numeric vector of the annual anomaly

plotAnnual

a logical value indicating if the annual anomaly should be shown in the scorecard bar, default is TRUE

xClimatology

a numeric vector of the months for the monthly climatology

yClimatology

a numeric vector of the climatology values for associated month

sdClimatology

a numeric vector of the standard deviation for the associated month

xlim

the x limits (x1, x2) of the plot

ylim

the y limits (y1, y2) of the plot

anomalyColors

a list that contains the colors and breaks of the desired color bar for the anomaly scorecard

scorecardSeparation

Value used to denote the separation between the main plot and scorecard. Suggested to use par('cin')[2] as a starting point and play with that value. If closer is desired, decrease.

scorecardWidth

Value used to denote the width of the scorecard. Suggested to use par('cin')[2] as a starting point and play with that value. If wider is desired, increase.

Details

This is the plot style that is used in many of Peter Galbraith's research documents. Was translated to R in efforts to better represent some data.

Author(s)

Chantelle Layton


clayton33/csasMarPhys documentation built on June 8, 2025, 3:10 a.m.