Browse Source

fixing docs

pull/45/head
boB Rudis 5 years ago
parent
commit
9ad95ba46a
No known key found for this signature in database GPG Key ID: 2A514A4997464560
  1. 4
      NAMESPACE
  2. 96
      man/stat_fill_labels.Rd
  3. 86
      man/stat_stack_labels.Rd

4
NAMESPACE

@ -25,9 +25,7 @@ export(Mb)
export(StatAsh)
export(StatBkde)
export(StatBkde2d)
export(StatFillLabels)
export(StatHorizon)
export(StatStackLabels)
export(StatStepribbon)
export(StatXspline)
export(annotate_textp)
@ -50,9 +48,7 @@ export(show_stateface)
export(stat_ash)
export(stat_bkde)
export(stat_bkde2d)
export(stat_fill_labels)
export(stat_horizon)
export(stat_stack_labels)
export(stat_stepribbon)
export(stat_xspline)
export(to_basic.GeomBkde2d)

96
man/stat_fill_labels.Rd

@ -1,96 +0,0 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stat_fill_labels.R
\name{stat_fill_labels}
\alias{stat_fill_labels}
\title{Labels position for fill position.}
\usage{
stat_fill_labels(mapping = NULL, data = NULL, geom = "text",
position = "identity", width = NULL, 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{geom}{Use to override the default connection between
\code{geom_text} and \code{stat_stack_labels}.}
\item{position}{Position adjustment, either as a string, or the result of
a call to a position adjustment function.}
\item{width}{Bar width. By default, set to 90\% of the resolution of the data.}
\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()}}.}
\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{color = "red"} or \code{size = 3}. They may also be parameters
to the paired geom/stat.}
}
\description{
Computes position of labels when using \code{position = "fill"}
}
\section{Computed variables}{
\describe{
\item{count}{the number of observations}
\item{prop}{proportion on \code{x}}
\item{cumprop}{the cumulative proportion on \code{x}}
\item{ylabel}{the y position of labels, i.e. \eqn{cumprop - prop / 2}}
}
}
\examples{
ggplot(as.data.frame(Titanic)) +
aes(x = Class, fill = Survived, weight = Freq) +
geom_bar(position = "fill") + stat_fill_labels()
ggplot(as.data.frame(Titanic)) +
aes(x = Class, fill = Survived, weight = Freq) +
geom_bar(position = "fill") + geom_label(stat = "fill_labels")
ggplot(as.data.frame(Titanic)) +
aes(x = Class, fill = Survived, weight = Freq) +
geom_bar(position = "fill") + geom_text(stat = "fill_labels") + facet_grid(~Sex)
ggplot(as.data.frame(Titanic)) +
aes(x = as.integer(Class), fill = Survived, weight = Freq) +
geom_area(position = "fill", stat = "count") + geom_text(stat = "fill_labels")
# Cumulative percentages with dodge position
ggplot(as.data.frame(Titanic)) +
aes(x = Class, fill = Survived, weight = Freq) +
geom_bar(aes(y = ..prop..), stat="fill_labels", position="dodge", width = .8) +
geom_text(
aes(label = scales::percent(..prop..), y = ..prop../2),
stat = "fill_labels", position = position_dodge(width = .8)
)
}
\seealso{
\code{\link{stat_stack_labels}} for \code{position = "stack"}.
}

86
man/stat_stack_labels.Rd

@ -1,86 +0,0 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stat_stack_labels.R
\name{stat_stack_labels}
\alias{stat_stack_labels}
\title{Labels position for stack position.}
\usage{
stat_stack_labels(mapping = NULL, data = NULL, geom = "text",
position = "identity", width = NULL, 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{geom}{Use to override the default connection between
\code{geom_text} and \code{stat_stack_labels}.}
\item{position}{Position adjustment, either as a string, or the result of
a call to a position adjustment function.}
\item{width}{Bar width. By default, set to 90\% of the resolution of the data.}
\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()}}.}
\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{color = "red"} or \code{size = 3}. They may also be parameters
to the paired geom/stat.}
}
\description{
Computes position of labels when using \code{position = "stack"}
}
\section{Computed variables}{
\describe{
\item{count}{the number of observations}
\item{cumcount}{the cumulative number of observations}
\item{ylabel}{the y position of labels, i.e. \eqn{cumcount - count / 2}}
}
}
\examples{
ggplot(as.data.frame(Titanic)) +
aes(x = Class, fill = Survived, weight = Freq) +
geom_bar() + stat_stack_labels()
ggplot(as.data.frame(Titanic)) +
aes(x = Class, fill = Survived, weight = Freq) +
geom_bar() + geom_label(stat = "stack_labels")
ggplot(as.data.frame(Titanic)) +
aes(x = Class, fill = Survived, weight = Freq) +
geom_bar() + stat_stack_labels() + facet_grid(~Sex)
ggplot(as.data.frame(Titanic)) +
aes(x = as.integer(Class), fill = Survived, weight = Freq) +
geom_area(stat = "count") + stat_stack_labels()
}
\seealso{
\code{\link{stat_fill_labels}} for \code{position = "fill"}.
}
Loading…
Cancel
Save