R/qqmath.zoo.R

Defines functions qqmath.zoo

Documented in qqmath.zoo

#' Q-Q Plots for Zoo Objects
#'
#' Draw quantile-Quantile plots of a sample against a theoretical distribution,
#' possibly conditioned on other variables.
#'
#' @param x A `zoo` object
#' @param data Ignored
#' @param xlab X axis label
#' @param ylab Y axis label
#' @param ref Plot a reference line via [lattice::panel.qqmathline()].
#' @param ci Plot confidence levels via [panel.qqmathci()].
#' @param ... Parameters to pass on to [lattice::qqmath()].
#'
#' @return Plots and returns a `trellis` object.
#' @author Original by Deepayan Sarkar.
#' @seealso [lattice::qqmath()], [zoo::zoo()], [lattice::panel.qqmathline()].
#' @export
#'
#' @examples
#' if (require(zoo))
#'   qqmath(zoo(lh))
qqmath.zoo <- function(
  x,
  data = NULL,
  xlab = "Theoretical quantiles",
  ylab = "Sample quantiles",
  ref = TRUE,
  ci = TRUE,
  ...
) {
  do.call(qqmath, updateList(list(
    x = ~ zoo::coredata(x),
    xlab = xlab,
    ylab = ylab,
    panel = function(...) {
      if (ci)
        panel.qqmathci(...)
      if (ref)
        panel.qqmathline(...)
      panel.qqmath(...)
    }
  ), list(...)))
}
jolars/tactile documentation built on May 26, 2023, 4:05 a.m.