ggcptplot: Plot for the changepoint package

In ggchangepoint: Combines Changepoint Analysis with 'ggplot2'

Plot for the changepoint package

Description

The plot for changepoints detected by the changepoint package is a line plot for the raw data and the vertical lines representing each changepoint. The x-axis is the row number of the raw data in the original data vector. The plot inherits ggplot2, meaning users can add ggplot2 functions on top the changepoint plot for customization.

Usage

ggcptplot(
  data,
  change_in = "mean_var",
  cp_method = "PELT",
  ...,
  cptline_alpha = 1,
  cptline_color = "blue",
  cptline_type = "solid",
  cptline_linewidth = 0.5,
  cptline_size = lifecycle::deprecated(),
  index = NULL,
  show_points = NULL,
  show_line = TRUE
)

Arguments

data	A numeric vector.
change_in	Choice of mean_var, mean, var, and np (or cpt_np for backward compatibility). Each choice corresponds to cpt.meanvar(), cpt.mean(), cpt.var() and cpt.np() respectively. The default is mean_var.
cp_method	A wide range of choices (i.e., AMOC, PELT, SegNeigh or BinSeg). Please note when change_in is np or cpt_np, PELT is the only option.
...	Extra arguments for each cpt function mentioned in the change_in section. For a change in mean (and for np) minseglen defaults to 2 rather than the engine's 1, so no segment is a single observation; pass it to choose another value. SegNeigh keeps the engine's default, which is the only one it implements.
cptline_alpha	The value of alpha for the vertical changepoint line(s), default is 1, meaning no transparency.
cptline_color	The color for the vertical changepoint line(s), default is blue.
cptline_type	The linetype for the vertical changepoint line(s), default is solid.
cptline_linewidth	The linewidth for the vertical changepoint line(s), default is 0.5.
cptline_size	Deprecated. Use cptline_linewidth instead.
index	Optional. A vector of x-axis labels (e.g. dates) of the same length as data.
show_points	Logical. Whether to draw data points. Defaults to TRUE when length(data) <= 500, FALSE otherwise.
show_line	Logical. Whether to draw the line. Defaults to TRUE.

Value

A line plot with data points along with the vertical lines representing changepoints.

See Also

Other plotting: ggcpt_compare_table(), ggcpt_eval(), ggcpt_interactive(), ggecpplot()

Examples

ggcptplot(c(rnorm(100,0,1),rnorm(100,0,10)))
ggcptplot(c(rnorm(100,0,1),rnorm(100,10,1)))

ggchangepoint documentation built on Nov. 5, 2026, 9:06 a.m.