Skip to content

Commit

Permalink
Re-document with roxygen2 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
wch committed Nov 20, 2013
1 parent ba0f953 commit a93eafd
Show file tree
Hide file tree
Showing 93 changed files with 787 additions and 870 deletions.
68 changes: 0 additions & 68 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -26,71 +26,3 @@ Suggests:
iterators
License: MIT
LazyData: true
Collate:
'dimensions.r'
'id.r'
'indexed-array.r'
'indexed-data-frame.r'
'indexed.r'
'join.r'
'loop-apply.r'
'progress.r'
'quote.r'
'split-indices.r'
'split.r'
'utils.r'
'utils-functional.r'
'data.r'
'plyr.r'
'parallel.r'
'progress-time.r'
'a_ply.r'
'aaply.r'
'adply.r'
'alply.r'
'd_ply.r'
'daply.r'
'ddply.r'
'dlply.r'
'l_ply.r'
'laply.r'
'llply.r'
'm_ply.r'
'maply.r'
'mdply.r'
'mlply.r'
'r_ply.r'
'raply.r'
'rdply.r'
'rlply.r'
'liply.r'
'ldply.r'
'arrange.r'
'colwise.r'
'count.r'
'data-frame.r'
'defaults.r'
'each.r'
'here.r'
'match-df.r'
'mutate.r'
'name-rows.r'
'quickdf.r'
'rename.r'
'revalue.r'
'round-any.r'
'splat.r'
'strip-splits.r'
'summarise.r'
'take.r'
'try.r'
'vaggregate.r'
'idataframe.r'
'join-all.r'
'list-to-array.r'
'list-to-dataframe.r'
'list-to-vector.r'
'rbind-fill-matrix.r'
'rbind-fill.r'
'splitter-a.r'
'splitter-d.r'
26 changes: 13 additions & 13 deletions man/a_ply.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
\alias{a_ply}
\title{Split array, apply function, and discard results.}
\usage{
a_ply(.data, .margins, .fun = NULL, ..., .expand = TRUE,
.progress = "none", .inform = FALSE, .print = FALSE,
.parallel = FALSE, .paropts = NULL)
a_ply(.data, .margins, .fun = NULL, ..., .expand = TRUE,
.progress = "none", .inform = FALSE, .print = FALSE,
.parallel = FALSE, .paropts = NULL)
}
\arguments{
\item{.fun}{function to apply to each piece}
Expand Down Expand Up @@ -45,11 +45,11 @@
\code{FALSE})}
}
\value{
Nothing
Nothing
}
\description{
For each slice of an array, apply function and discard
results
For each slice of an array, apply function and discard
results
}
\section{Input}{
This function splits matrices, arrays and data frames by
Expand All @@ -62,16 +62,16 @@
displaying plots or saving output.
}
\references{
Hadley Wickham (2011). The Split-Apply-Combine Strategy
for Data Analysis. Journal of Statistical Software,
40(1), 1-29. \url{http://www.jstatsoft.org/v40/i01/}.
Hadley Wickham (2011). The Split-Apply-Combine Strategy for
Data Analysis. Journal of Statistical Software, 40(1),
1-29. \url{http://www.jstatsoft.org/v40/i01/}.
}
\seealso{
Other array input: \code{\link{aaply}},
\code{\link{adply}}, \code{\link{alply}}
Other array input: \code{\link{aaply}},
\code{\link{adply}}, \code{\link{alply}}

Other no output: \code{\link{d_ply}},
\code{\link{l_ply}}, \code{\link{m_ply}}
Other no output: \code{\link{d_ply}}, \code{\link{l_ply}},
\code{\link{m_ply}}
}
\keyword{manip}

44 changes: 22 additions & 22 deletions man/aaply.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
\alias{aaply}
\title{Split array, apply function, and return results in an array.}
\usage{
aaply(.data, .margins, .fun = NULL, ..., .expand = TRUE,
.progress = "none", .inform = FALSE, .drop = TRUE,
.parallel = FALSE, .paropts = NULL)
aaply(.data, .margins, .fun = NULL, ..., .expand = TRUE,
.progress = "none", .inform = FALSE, .drop = TRUE, .parallel = FALSE,
.paropts = NULL)
}
\arguments{
\item{.fun}{function to apply to each piece}
Expand Down Expand Up @@ -46,22 +46,22 @@
\code{TRUE}}
}
\value{
if results are atomic with same type and dimensionality,
a vector, matrix or array; otherwise, a list-array (a
list with dimensions)
if results are atomic with same type and dimensionality, a
vector, matrix or array; otherwise, a list-array (a list
with dimensions)
}
\description{
For each slice of an array, apply function, keeping
results as an array.
For each slice of an array, apply function, keeping results
as an array.
}
\details{
This function is very similar to \code{\link{apply}},
except that it will always return an array, and when the
function returns >1 d data structures, those dimensions
are added on to the highest dimensions, rather than the
lowest dimensions. This makes \code{aaply} idempotent,
so that \code{aaply(input, X, identity)} is equivalent to
\code{aperm(input, X)}.
This function is very similar to \code{\link{apply}},
except that it will always return an array, and when the
function returns >1 d data structures, those dimensions are
added on to the highest dimensions, rather than the lowest
dimensions. This makes \code{aaply} idempotent, so that
\code{aaply(input, X, identity)} is equivalent to
\code{aperm(input, X)}.
}
\section{Input}{
This function splits matrices, arrays and data frames by
Expand Down Expand Up @@ -92,16 +92,16 @@ aaply(ozone, 1:2, standardise)
aaply(ozone, 1:2, diff)
}
\references{
Hadley Wickham (2011). The Split-Apply-Combine Strategy
for Data Analysis. Journal of Statistical Software,
40(1), 1-29. \url{http://www.jstatsoft.org/v40/i01/}.
Hadley Wickham (2011). The Split-Apply-Combine Strategy for
Data Analysis. Journal of Statistical Software, 40(1),
1-29. \url{http://www.jstatsoft.org/v40/i01/}.
}
\seealso{
Other array input: \code{\link{a_ply}},
\code{\link{adply}}, \code{\link{alply}}
Other array input: \code{\link{a_ply}},
\code{\link{adply}}, \code{\link{alply}}

Other array output: \code{\link{daply}},
\code{\link{laply}}, \code{\link{maply}}
Other array output: \code{\link{daply}},
\code{\link{laply}}, \code{\link{maply}}
}
\keyword{manip}

26 changes: 13 additions & 13 deletions man/adply.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
\alias{adply}
\title{Split array, apply function, and return results in a data frame.}
\usage{
adply(.data, .margins, .fun = NULL, ..., .expand = TRUE,
.progress = "none", .inform = FALSE, .parallel = FALSE,
.paropts = NULL)
adply(.data, .margins, .fun = NULL, ..., .expand = TRUE,
.progress = "none", .inform = FALSE, .parallel = FALSE,
.paropts = NULL)
}
\arguments{
\item{.fun}{function to apply to each piece}
Expand Down Expand Up @@ -42,11 +42,11 @@
variable.}
}
\value{
A data frame, as described in the output section.
A data frame, as described in the output section.
}
\description{
For each slice of an array, apply function then combine
results into a data frame.
For each slice of an array, apply function then combine
results into a data frame.
}
\section{Input}{
This function splits matrices, arrays and data frames by
Expand All @@ -66,16 +66,16 @@
(\code{data.frame()}).
}
\references{
Hadley Wickham (2011). The Split-Apply-Combine Strategy
for Data Analysis. Journal of Statistical Software,
40(1), 1-29. \url{http://www.jstatsoft.org/v40/i01/}.
Hadley Wickham (2011). The Split-Apply-Combine Strategy for
Data Analysis. Journal of Statistical Software, 40(1),
1-29. \url{http://www.jstatsoft.org/v40/i01/}.
}
\seealso{
Other array input: \code{\link{a_ply}},
\code{\link{aaply}}, \code{\link{alply}}
Other array input: \code{\link{a_ply}},
\code{\link{aaply}}, \code{\link{alply}}

Other data frame output: \code{\link{ddply}},
\code{\link{ldply}}, \code{\link{mdply}}
Other data frame output: \code{\link{ddply}},
\code{\link{ldply}}, \code{\link{mdply}}
}
\keyword{manip}

38 changes: 19 additions & 19 deletions man/alply.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
\alias{alply}
\title{Split array, apply function, and return results in a list.}
\usage{
alply(.data, .margins, .fun = NULL, ..., .expand = TRUE,
.progress = "none", .inform = FALSE, .parallel = FALSE,
.paropts = NULL, .dims = FALSE)
alply(.data, .margins, .fun = NULL, ..., .expand = TRUE,
.progress = "none", .inform = FALSE, .parallel = FALSE,
.paropts = NULL, .dims = FALSE)
}
\arguments{
\item{.fun}{function to apply to each piece}
Expand Down Expand Up @@ -45,20 +45,20 @@
names from input.}
}
\value{
list of results
list of results
}
\description{
For each slice of an array, apply function then combine
results into a list.
For each slice of an array, apply function then combine
results into a list.
}
\details{
The list will have "dims" and "dimnames" corresponding to
the margins given. For instance \code{alply(x, c(3,2),
...)} where \code{x} has dims \code{c(4,3,2)} will give a
result with dims \code{c(2,3)}.
The list will have "dims" and "dimnames" corresponding to
the margins given. For instance \code{alply(x, c(3,2),
...)} where \code{x} has dims \code{c(4,3,2)} will give a
result with dims \code{c(2,3)}.

\code{alply} is somewhat similar to \code{\link{apply}}
for cases where the results are not atomic.
\code{alply} is somewhat similar to \code{\link{apply}} for
cases where the results are not atomic.
}
\section{Input}{
This function splits matrices, arrays and data frames by
Expand All @@ -74,16 +74,16 @@ alply(ozone, 3, quantile)
alply(ozone, 3, function(x) table(round(x)))
}
\references{
Hadley Wickham (2011). The Split-Apply-Combine Strategy
for Data Analysis. Journal of Statistical Software,
40(1), 1-29. \url{http://www.jstatsoft.org/v40/i01/}.
Hadley Wickham (2011). The Split-Apply-Combine Strategy for
Data Analysis. Journal of Statistical Software, 40(1),
1-29. \url{http://www.jstatsoft.org/v40/i01/}.
}
\seealso{
Other array input: \code{\link{a_ply}},
\code{\link{aaply}}, \code{\link{adply}}
Other array input: \code{\link{a_ply}},
\code{\link{aaply}}, \code{\link{adply}}

Other list output: \code{\link{dlply}},
\code{\link{llply}}, \code{\link{mlply}}
Other list output: \code{\link{dlply}},
\code{\link{llply}}, \code{\link{mlply}}
}
\keyword{manip}

4 changes: 2 additions & 2 deletions man/amv_dim.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
\alias{amv_dim}
\title{Dimensions.}
\usage{
amv_dim(x)
amv_dim(x)
}
\arguments{
\item{x}{array, matrix or vector}
}
\description{
Consistent dimensions for vectors, matrices and arrays.
Consistent dimensions for vectors, matrices and arrays.
}
\keyword{internal}

12 changes: 6 additions & 6 deletions man/amv_dimnames.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@
\alias{amv_dimnames}
\title{Dimension names.}
\usage{
amv_dimnames(x)
amv_dimnames(x)
}
\arguments{
\item{x}{array, matrix or vector}
}
\description{
Consistent dimnames for vectors, matrices and arrays.
Consistent dimnames for vectors, matrices and arrays.
}
\details{
Unlike \code{\link{dimnames}} no part of the output will
ever be null. If a component of dimnames is omitted,
\code{amv_dimnames} will return an integer sequence of
the appropriate length.
Unlike \code{\link{dimnames}} no part of the output will
ever be null. If a component of dimnames is omitted,
\code{amv_dimnames} will return an integer sequence of the
appropriate length.
}
\keyword{internal}

16 changes: 8 additions & 8 deletions man/arrange.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
\alias{arrange}
\title{Order a data frame by its colums.}
\usage{
arrange(df, ...)
arrange(df, ...)
}
\arguments{
\item{df}{data frame to reorder}
Expand All @@ -11,11 +11,11 @@
\code{df} and then fed to \code{\link{order}}}
}
\description{
This function completes the subsetting, transforming and
ordering triad with a function that works in a similar
way to \code{\link{subset}} and \code{\link{transform}}
but for reordering a data frame by its columns. This
saves a lot of typing!
This function completes the subsetting, transforming and
ordering triad with a function that works in a similar way
to \code{\link{subset}} and \code{\link{transform}} but for
reordering a data frame by its columns. This saves a lot of
typing!
}
\examples{
# sort mtcars data by cylinder and displacement
Expand All @@ -30,8 +30,8 @@ arrange(myCars, cyl, disp)
arrange(myCars, cyl, desc(disp))
}
\seealso{
\code{\link{order}} for sorting function in the base
package
\code{\link{order}} for sorting function in the base
package
}
\keyword{manip}

Loading

0 comments on commit a93eafd

Please sign in to comment.