You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 lines
1.2 KiB
38 lines
1.2 KiB
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/geom_horizon.r
|
|
\docType{data}
|
|
\name{geom_horizon}
|
|
\alias{geom_horizon}
|
|
\alias{GeomHorizon}
|
|
\alias{stat_horizon}
|
|
\alias{StatHorizon}
|
|
\title{Plot a time series as a horizon plot}
|
|
\format{An object of class \code{GeomHorizon} (inherits from \code{GeomArea}, \code{GeomRibbon}, \code{Geom}, \code{ggproto}, \code{gg}) of length 4.}
|
|
\usage{
|
|
geom_horizon(mapping = NULL, data = NULL, show.legend = TRUE,
|
|
inherit.aes = TRUE, na.rm = TRUE, bandwidth = NULL, ...)
|
|
|
|
GeomHorizon
|
|
|
|
stat_horizon(mapping = NULL, data = NULL, geom = "horizon",
|
|
show.legend = TRUE, inherit.aes = TRUE, na.rm = TRUE,
|
|
bandwidth = NULL, ...)
|
|
|
|
StatHorizon
|
|
}
|
|
\description{
|
|
A horizon plot breaks the Y dimension down using colours. This is useful
|
|
when visualising y values spanning a vast range and / or trying to highlight
|
|
outliers without losing context of the rest of the data.\cr \cr Horizon
|
|
plots are best viewed in an apsect ratio of very low vertical length.
|
|
}
|
|
\section{Aesthetics}{
|
|
\code{x}, \code{y}, \code{fill}. \code{fill} defaults to \code{..band..} which is
|
|
the band number the current data fill area belongs in.
|
|
}
|
|
|
|
\section{Other parameters}{
|
|
\code{bandwidth}, to dictate the span of a band.
|
|
}
|
|
|
|
\keyword{internal}
|
|
|