Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

Commit

Permalink
Re-document
Browse files Browse the repository at this point in the history
  • Loading branch information
wch committed Sep 24, 2014
1 parent 3e6ce50 commit 5b3d97c
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 44 deletions.
15 changes: 6 additions & 9 deletions man/bin_vector.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,21 @@
bin_vector(x, weight = NULL, ...)
}
\arguments{
\item{x}{a vector to bin}
\item{x}{A vector to bin}

\item{weight}{if specified, an integer vector of the same length as \code{x}
\item{weight}{If specified, an integer vector of the same length as \code{x}
representing the number of occurances of each value in \code{x}}

\item{...}{additional arguments passed through to instances of the generic}
\item{...}{additional arguments passed through to methods.}

\item{width}{the width of a bin}
\item{width}{The width of a bin}

\item{center}{the center of a bin}

\item{boundary}{the boundary of a bin. \code{center} and \code{boundary} should
not both be specified.}
\item{origin}{The left-most value for bins.}

\item{closed}{One of \code{"right"} or \code{"left"} indicating whether
right or left edges of bins are included in the bin.}

\item{pad}{a logical indicatign whether the bins should be padded to include
\item{pad}{A logical indicating whether the bins should be padded to include
an empty bin on each side.}
}
\description{
Expand Down
38 changes: 19 additions & 19 deletions man/compute_bin.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -13,30 +13,30 @@ grouped data frames and ggvis visualisations.}
\item{x_var,w_var}{Names of x and weight variables. The x variable must be
continuous.}

\item{width}{The width of the bins. The default is \code{NULL}, which
yields 30 bins that cover the range of the data. You should always override
this value, exploring multiple widths to find the best to illustrate the
stories in your data.}
\item{width}{The width of the bins. The default is \code{NULL}, which yields
30 bins that cover the range of the data. You should always override this
value, exploring multiple widths to find the best to illustrate the stories
in your data.}

\item{center}{The center of one of the bins. Note that if center is above or below
the range of the data, things will be shifted by an appropriate number of \code{width}s.
To center on integers,
for example, use \code{width = 1} and \code{center = 0}, even if \code{0} is
outside the range of the data. At most one of \code{center} and \code{boundary} may be
\item{center}{The center of one of the bins. Note that if center is above or
below the range of the data, things will be shifted by an appropriate
number of \code{width}s. To center on integers, for example, use
\code{width=1} and \code{center=0}, even if \code{0} is outside the range
of the data. At most one of \code{center} and \code{boundary} may be
specified.}

\item{boundary}{A boundary between two bins. As with \code{center}, things are shifted
when \code{boundary} is outside the range of the data. For example, to center on
integers, use \code{width = 1} and \code{boundary = 0.5}, even if \code{1} is outside
the range of the data. At most one of \code{center} and \code{boundary} may be
specified.}
\item{boundary}{A boundary between two bins. As with \code{center}, things
are shifted when \code{boundary} is outside the range of the data. For
example, to center on integers, use \code{width = 1} and \code{boundary =
0.5}, even if \code{1} is outside the range of the data. At most one of
\code{center} and \code{boundary} may be specified.}

\item{closed}{One of \code{"right"} or \code{"left"} indicating whether
right or left edges of bins are included in the bin.}
\item{closed}{One of \code{"right"} or \code{"left"} indicating whether right
or left edges of bins are included in the bin.}

\item{pad}{If \code{TRUE}, adds empty bins at either end of x. This
ensures frequency polygons touch 0, and adds padding between the data
and axis for histograms.}
\item{pad}{If \code{TRUE}, adds empty bins at either end of x. This ensures
frequency polygons touch 0, and adds padding between the data and axis for
histograms.}
}
\value{
A data frame with columns:
Expand Down
32 changes: 16 additions & 16 deletions man/layer_histograms.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,26 @@ layer_freqpolys(vis, ..., width = NULL, center = NULL, boundary = NULL,

\item{...}{Visual properties used to override defaults.}

\item{width}{The width of the bins. The default is \code{NULL}, which
yields 30 bins that cover the range of the data. You should always override
this value, exploring multiple widths to find the best to illustrate the
stories in your data.}
\item{width}{The width of the bins. The default is \code{NULL}, which yields
30 bins that cover the range of the data. You should always override this
value, exploring multiple widths to find the best to illustrate the stories
in your data.}

\item{center}{The center of one of the bins. Note that if center is above or below
the range of the data, things will be shifted by an appropriate number of \code{width}s.
To center on integers,
for example, use \code{width = 1} and \code{center = 0}, even if \code{0} is
outside the range of the data. At most one of \code{center} and \code{boundary} may be
\item{center}{The center of one of the bins. Note that if center is above or
below the range of the data, things will be shifted by an appropriate
number of \code{width}s. To center on integers, for example, use
\code{width=1} and \code{center=0}, even if \code{0} is outside the range
of the data. At most one of \code{center} and \code{boundary} may be
specified.}

\item{boundary}{A boundary between two bins. As with \code{center}, things are shifted
when \code{boundary} is outside the range of the data. For example, to center on
integers, use \code{width = 1} and \code{boundary = 0.5}, even if \code{1} is outside
the range of the data. At most one of \code{center} and \code{boundary} may be
specified.}
\item{boundary}{A boundary between two bins. As with \code{center}, things
are shifted when \code{boundary} is outside the range of the data. For
example, to center on integers, use \code{width = 1} and \code{boundary =
0.5}, even if \code{1} is outside the range of the data. At most one of
\code{center} and \code{boundary} may be specified.}

\item{closed}{One of \code{"right"} or \code{"left"} indicating whether
right or left edges of bins are included in the bin.}
\item{closed}{One of \code{"right"} or \code{"left"} indicating whether right
or left edges of bins are included in the bin.}

\item{stack}{If \code{TRUE}, will automatically stack overlapping bars.}
}
Expand Down

0 comments on commit 5b3d97c

Please sign in to comment.