R/print_segmentr.R

In segmentr: Segment Data With Maximum Likelihood

#' Print a segmentr object
#'
#' Prints a short description of the segments found in the `segmentr` object
#'
#' A short representation of the segments is printed on the screen, using the
#' `start:end` range notation.
#'
#' @param x an object of type segmentr, containing change point information
#' @param ... further arguments to be passed down to other methods
#'
#' @examples
#' make_segment <- function(n, p) matrix(rbinom(100 * n, 1, p), nrow = 100)
#' data <- cbind(make_segment(5, 0.1), make_segment(10, 0.9), make_segment(2, 0.1))
#' mean_lik <- function(X) abs(mean(X) - 0.5) * ncol(X)^2
#' x <- segment(data, likelihood = mean_lik, algorithm = "hieralg")
#' print(x)
#' @export
print.segmentr <- function(x, ...) {
  starts <- sapply(x$segments, head, 1)
  ends <- sapply(x$segments, tail, 1)
  segment_strings <- foreach(start = starts, end = ends, .combine = c) %do% glue::glue("{start}:{end}")
  segment_strings <- glue::glue_collapse(segment_strings, sep = "\n")
  output <- glue::glue("
  Segments (total of {length(x$segments)}):

  {segment_strings}
  ")

  print(output, ...)
}