R/recall_plots.R

In WarwickCIM/backfillz: MCMC visualisation package

#' Recall a series of plots from the backfillz object using
#'  the ID from the summary() function
#'
#' @param object            Backfillz or Stanfit object. Stanfit
#'  objects are converted to Backfillz object using the as_backfillz function.
#' @param id                Vector of strings giving the
#'  parameters to plot (e.g., c('mu', 'sd')).
recall_plots <- function(object, id = NULL) {

  # Check input
  if (!class(object) == "backfillz") {
    stop("Object is not a stanfit, Backfillz or data frame object")
  }

  assertive::assert_is_s4(object)
  assertive::assert_is_numeric(id)

  # plot plots corresponding to id
  found <- 0
  for (i in seq_len(length(object@plot_store))) {
    # 1 is the creation entry in the log
    if (object@plot_store[[i]]$ID == id) {
      print(object@plot_store[[i]]$plot)
      Sys.sleep(time = 5)
      found <- found + 1
    }
  }

  message(paste("Found", found, " plots matching the ID ", id))
}