plotHHH4_season_groups {hhh4contacts}

Plot Seasonality of a hhh4 Fit by Group

Description

A plot method for models with group-specific seasonality terms that are not handled correctly by plotHHH4_season.

Usage

plotHHH4_season_groups(
  x,
  component = "end",
  seasonStart = 1,
  conf.level = 0.95,
  conf.B = 999,
  col = 1:6,
  xlab = "time",
  ylab = "multiplicative effect",
  ...,
  refline.args = list(),
  yearline.args = list(),
  legend.args = list()
)

Arguments

x

an object of class "hhh4".

component

character string indicating from which component seasonality terms should be extracted.

seasonStart

an integer defining the epochInYear that starts a new season (by default the first).

conf.level, conf.B

a confidence level for the pointwise confidence intervals around the group-specific seasonal effects. The confidence intervals are based on quantiles of conf.B samples from the asymptotic multivariate normal distribution of the maximum likelihood estimate. Alternatively, if conf.level = NA, the individual samples are drawn instead of the confidence lines. Set conf.level = NULL to disable confidence intervals.

col

a vector of group-specific colors, recycled as necessary and passed to matplot.

xlab, ylab, ...

arguments passed to matplot.

refline.args

a list of arguments for abline to change the style of the horizontal reference line at 1. This line is omitted if refline.args is not a list.

yearline.args

a list of arguments for abline to change the style of the line marking the end of the year at x$stsObj@freq if seasonStart is not 1. This line is omitted if yearline.args is not a list.

legend.args

a list of arguments for legend modifying the internal defaults. If legend.args is not a list, the legend is omitted.

Value

a matrix of the plotted point estimates of the multiplicative seasonal effect by group.