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.
85 lines
3.1 KiB
85 lines
3.1 KiB
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/geom_spikelines.R
|
|
\name{geom_spikelines}
|
|
\alias{geom_spikelines}
|
|
\title{Draw spikelines on a plot}
|
|
\usage{
|
|
geom_spikelines(mapping = NULL, data = NULL, stat = "identity",
|
|
position = "identity", ..., arrow = NULL, lineend = "butt",
|
|
linejoin = "round", na.rm = FALSE, show.legend = NA,
|
|
inherit.aes = TRUE)
|
|
}
|
|
\arguments{
|
|
\item{mapping}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} or
|
|
\code{\link[=aes_]{aes_()}}. If specified and \code{inherit.aes = TRUE} (the
|
|
default), it is combined with the default mapping at the top level of the
|
|
plot. You must supply \code{mapping} if there is no plot mapping.}
|
|
|
|
\item{data}{The data to be displayed in this layer. There are three
|
|
options:
|
|
|
|
If \code{NULL}, the default, the data is inherited from the plot
|
|
data as specified in the call to \code{\link[=ggplot]{ggplot()}}.
|
|
|
|
A \code{data.frame}, or other object, will override the plot
|
|
data. All objects will be fortified to produce a data frame. See
|
|
\code{\link[=fortify]{fortify()}} for which variables will be created.
|
|
|
|
A \code{function} will be called with a single argument,
|
|
the plot data. The return value must be a \code{data.frame}, and
|
|
will be used as the layer data.}
|
|
|
|
\item{stat}{The statistical transformation to use on the data for this
|
|
layer, as a string.}
|
|
|
|
\item{position}{Position adjustment, either as a string, or the result of
|
|
a call to a position adjustment function.}
|
|
|
|
\item{...}{Other arguments passed on to \code{\link[=layer]{layer()}}. These are
|
|
often aesthetics, used to set an aesthetic to a fixed value, like
|
|
\code{colour = "red"} or \code{size = 3}. They may also be parameters
|
|
to the paired geom/stat.}
|
|
|
|
\item{arrow}{Arrow specification, as created by \code{\link[grid:arrow]{grid::arrow()}}.}
|
|
|
|
\item{lineend}{Line end style (round, butt, square).}
|
|
|
|
\item{linejoin}{Line join style (round, mitre, bevel).}
|
|
|
|
\item{na.rm}{If \code{FALSE}, the default, missing values are removed with
|
|
a warning. If \code{TRUE}, missing values are silently removed.}
|
|
|
|
\item{show.legend}{logical. Should this layer be included in the legends?
|
|
\code{NA}, the default, includes if any aesthetics are mapped.
|
|
\code{FALSE} never includes, and \code{TRUE} always includes.
|
|
It can also be a named logical vector to finely select the aesthetics to
|
|
display.}
|
|
|
|
\item{inherit.aes}{If \code{FALSE}, overrides the default aesthetics,
|
|
rather than combining with them. This is most useful for helper functions
|
|
that define both data and aesthetics and shouldn't inherit behaviour from
|
|
the default plot specification, e.g. \code{\link[=borders]{borders()}}.}
|
|
}
|
|
\description{
|
|
Segment reference lines that originate at an point
|
|
}
|
|
\examples{
|
|
|
|
mtcars$name <- rownames(mtcars)
|
|
|
|
p <- ggplot(data = mtcars, aes(x=mpg,y=disp)) + geom_point()
|
|
|
|
p + geom_spikelines(data = mtcars[mtcars$carb==4,],linetype = 2)
|
|
|
|
p + geom_spikelines(data = mtcars[mtcars$carb==4,],aes(colour = factor(gear)), linetype = 2)
|
|
|
|
\dontrun{
|
|
require(ggrepel)
|
|
p + geom_spikelines(data = mtcars[mtcars$carb==4,],aes(colour = factor(gear)), linetype = 2) +
|
|
ggrepel::geom_label_repel(data = mtcars[mtcars$carb==4,],aes(label = name))
|
|
}
|
|
|
|
}
|
|
\author{
|
|
Jonathan Sidi
|
|
}
|
|
|