R/stat_occurrence.R

In Ather-Energy/ggTimeSeries: Time Series Visualisations Using the Grammar of Graphics

#' Transforms data for an occurrence plot
StatOccurrence <- ggproto(
  "StatOccurrence",
  Stat,
  required_aes = c("x", "y"),
  compute_group = function(data, scales) {
    data <- do.call(
      rbind,
      lapply(
        seq(nrow(data)),
        function(iRow) {
          data.frame(
            x = data$x[iRow],
            y = 0:round(data$y[iRow])
          )
        }
      )
    )
    data <- data[data$y != 0, ]
    data
  }
)

#' Plots a time series as a dot plot
#' @param mapping mapping
#' @param data df
#' @param show.legend logical
#' @param inherit.aes logical
#' @param na.rm logical
#' @param bandwidth bandwidth
#' @param ... more functions
#'
#' For rare events, it's convenient to have the count of events encoded in
#' the chart itself. A bar chart requires the user to perceive the y axis which
#' this does not.
#'
#' @section Aesthetics: x, y
#' @section Cosmetic Tips: The minimalist look can be achieved by appending the
#' following chunk of code to the output object:
#' \code{  +
#'    xlab(NULL) +
#'    ylab(NULL) +
#'    scale_fill_continuous(low = 'green', high = 'red') +
#'    theme(
#'       axis.text.y = element_blank(),
#'       axis.ticks.y = element_blank(),
#'       legend.position = 'none',
#'       strip.background = element_blank(),
#'       panel.background = element_blank(),
#'       panel.border = element_blank(),
#'       panel.grid = element_blank(),
#'       panel.border = element_blank()
#'    ) +
#'    coord_fixed(ylim = c(0,1 + max(dfData$y)))
#' }
#'  \link[ggplot2]{coord_fixed}  can provide a balance to the aspect ratio of the chart.
#' @export
#' @import ggplot2
#' @examples {
#' library(data.table)
#' library(ggplot2)
#' set.seed(1)
#' dfData = data.table(x = 1:100, y = floor(4 * abs(rnorm(100, 0 , 0.4))))
#' ggplot(dfData, aes(x =x, y = y) )+
#'    stat_occurrence()+
#'    coord_fixed()}
stat_occurrence <- function(mapping = NULL,
                            data = NULL,
                            show.legend = NA,
                            inherit.aes = TRUE,
                            na.rm = T,
                            bandwidth = NULL,
                            ...) {
  list(
    layer(
      stat = StatOccurrence,
      data = data,
      mapping = mapping,
      geom = "point",
      position = "identity",
      show.legend = show.legend,
      inherit.aes = inherit.aes,
      params = list(na.rm = na.rm, ...)
    )
  )
}