-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
Copy pathlink_stat.Rd
37 lines (35 loc) · 1.08 KB
/
link_stat.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stat-chain.R
\name{link_stat}
\alias{link_stat}
\title{Parameterise a statistic computation}
\usage{
link_stat(stat, ..., after.stat = aes())
}
\arguments{
\item{stat}{The statistical transformation to use on the data. The \code{stat}
argument accepts the following:
\itemize{
\item A \code{Stat} ggproto subclass, for example \code{StatCount}.
\item A string naming the stat. To give the stat as a string, strip the
function name of the \code{stat_} prefix. For example, for \code{stat_count()}, give
the string \code{"count"}.
}}
\item{...}{Other arguments passed to the stat as a parameter.}
\item{after.stat}{Set of aesthetic mappings created by \code{\link[=aes]{aes()}} to be
evaluated only after the stat has been computed.}
}
\value{
A list bundling the stat, parameters and mapping.
}
\description{
This is a helper function for \code{\link[=stat_chain]{stat_chain()}} to pass parameters and declare
mappings.
}
\examples{
# See `?stat_chain`
}
\seealso{
\code{\link[=stat_chain]{stat_chain()}}
}
\keyword{internal}