File: stat_bindot.Rd

package info (click to toggle)
r-cran-ggplot2 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 4,412 kB
  • sloc: sh: 9; makefile: 1
file content (81 lines) | stat: -rw-r--r-- 2,932 bytes parent folder | download
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
% Generated by roxygen2 (4.0.1): do not edit by hand
\name{stat_bindot}
\alias{stat_bindot}
\title{Bin data for dot plot.}
\usage{
stat_bindot(mapping = NULL, data = NULL, geom = "dotplot",
  position = "identity", binwidth = NULL, origin = NULL, width = 0.9,
  binaxis = "x", method = "dotdensity", binpositions = "bygroup",
  drop = FALSE, right = TRUE, na.rm = FALSE, ...)
}
\arguments{
\item{binaxis}{The axis to bin along, "x" (default) or "y"}

\item{method}{"dotdensity" (default) for dot-density binning, or
"histodot" for fixed bin widths (like stat_bin)}

\item{binwidth}{When \code{method} is "dotdensity, this specifies maximum bin width.
When \code{method} is "histodot", this specifies bin width.
Defaults to 1/30 of the range of the data}

\item{binpositions}{When \code{method} is "dotdensity", "bygroup" (default)
determines positions of the bins for each group separately. "all" determines
positions of the bins with all the data taken together; this is used for
aligning dot stacks across multiple groups.}

\item{origin}{When \code{method} is "histodot", origin of first bin}

\item{right}{When \code{method} is "histodot", should intervals be closed
on the right (a, b], or not [a, b)}

\item{width}{When \code{binaxis} is "y", the spacing of the dot stacks
for dodging.}

\item{na.rm}{If \code{FALSE} (the default), removes missing values with
a warning.  If \code{TRUE} silently removes missing values.}

\item{drop}{If TRUE, remove all bins with zero counts}

\item{mapping}{The aesthetic mapping, usually constructed with
\code{\link{aes}} or \code{\link{aes_string}}. Only needs to be set
at the layer level if you are overriding the plot defaults.}

\item{data}{A layer specific dataset - only needed if you want to override
the plot defaults.}

\item{geom}{The geometric object to use display the data}

\item{position}{The position adjustment to use for overlappling points
on this layer}

\item{...}{other arguments passed on to \code{\link{layer}}. This can
include aesthetics whose values you want to set, not map. See
\code{\link{layer}} for more details.}
}
\value{
New data frame with additional columns:
  \item{x}{center of each bin, if binaxis is "x"}
  \item{y}{center of each bin, if binaxis is "x"}
  \item{binwidth}{max width of each bin if method is "dotdensity";
    width of each bin if method is "histodot"}
  \item{count}{number of points in bin}
  \item{ncount}{count, scaled to maximum of 1}
  \item{density}{density of points in bin, scaled to integrate to 1,
    if method is "histodot"}
  \item{ndensity}{density, scaled to maximum of 1, if method is "histodot"}
}
\description{
Missing values are currently silently dropped.
If weights are used, they must be integer values.
}
\section{Aesthetics}{

\Sexpr[results=rd,stage=build]{ggplot2:::rd_aesthetics("stat", "bindot")}
}
\examples{
# See geom_dotplot for examples
}
\seealso{
See \code{\link{geom_dotplot}} for examples.
}