R/plothpp_step.R

In ppdiag: Diagnosis and Visualizations Tools for Temporal Point Processes

#' Draw step function for homogeneous Poisson process
#'
#' Draw the event time counts for homogeneous poisson process
#'
#' @param events parameters for homogeneous poisson process
#' @param color A specification for the default plotting color.
#' @importFrom graphics plot
#' @importFrom stats stepfun
#' @noRd
#' @examples
#' pois_y <- pp_hpp(lambda = 1)
#' events <- pp_simulate(pois_y, end = 10, n = 50)
#' plothpp_step(events)
plothpp_step <- function(events, color = "red") {
  if (is.null(events)) {
    stop("No events provided")
  }
  if (length(events) == 1) {
    if (events == 0) {
      stop("No events provided")
    }
  }
  count <- 0:length(events)
  plot(stepfun(x = events, y = count),
    main = "Homogeneous Poisson Process",
    xlab = "Event Time", ylab = "Number of events", col = color
  )
}