Upgrade to roxygen2 4.0

mtaka · Feb 20, 2014 · 06ee4af · 06ee4af
1 parent eb49a0e
commit 06ee4af
Show file tree

Hide file tree

Showing 72 changed files with 289 additions and 272 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -8,6 +8,7 @@ Maintainer: Hadley Wickham <[email protected]>
 Description: A fast, consistent tool for working with data frame like objects,
     both in memory and out of memory.
 URL: https://github.com/hadley/dplyr
+Roxygen: list(wrap = FALSE)
 Depends:
     R (>= 3.0.2)
 Imports:

diff --git a/NAMESPACE b/NAMESPACE
@@ -1,3 +1,5 @@
+# Generated by roxygen2 (4.0.0): do not edit by hand
+
 S3method(all.equal,data.frame)
 S3method(anti_join,data.frame)
 S3method(anti_join,tbl_df)
@@ -350,8 +352,8 @@ export(union)
 export(with_order)
 exportClasses(Query)
 import(assertthat)
-importFrom(Rcpp,cppFunction)
 importFrom(Rcpp,Rcpp.plugin.maker)
+importFrom(Rcpp,cppFunction)
 importFrom(methods,setRefClass)
 importFrom(utils,head)
 importFrom(utils,tail)

diff --git a/man/all.equal.data.frame.Rd b/man/all.equal.data.frame.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{all.equal.data.frame}
 \alias{all.equal.data.frame}
 \title{Provide a useful implementation of all.equal for data.frames.}
@@ -21,14 +22,12 @@
   generic.}
 }
 \value{
-\code{TRUE} if equal, otherwise a character vector
-describing the first reason why they're not equal. Use
-\code{\link{isTRUE}} if using the result in an \code{if}
-expression.
+\code{TRUE} if equal, otherwise a character vector describing
+  the first reason why they're not equal. Use \code{\link{isTRUE}} if
+  using the result in an \code{if} expression.
 }
 \description{
-Provide a useful implementation of all.equal for
-data.frames.
+Provide a useful implementation of all.equal for data.frames.
 }
 \examples{
 scramble <- function(x) x[sample(nrow(x)), sample(ncol(x))]

diff --git a/man/as.tbl_cube.Rd b/man/as.tbl_cube.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{as.tbl_cube}
 \alias{as.tbl_cube}
 \alias{as.tbl_cube.array}

diff --git a/man/bench_compare.Rd b/man/bench_compare.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{bench_compare}
 \alias{bench_compare}
 \alias{bench_tbls}
@@ -36,15 +37,15 @@ eval_tbls(tbls, op)
 \value{
 \code{eval_tbls}: a list of data frames.
 
-\code{compare_tbls}: an invisible \code{TRUE} on success,
-otherwise an error is thrown.
+  \code{compare_tbls}: an invisible \code{TRUE} on success, otherwise
+  an error is thrown.
 
-\code{bench_tbls}: an object of class
-\code{\link[microbenchmark]{microbenchmark}}
+  \code{bench_tbls}: an object of class
+  \code{\link[microbenchmark]{microbenchmark}}
 }
 \description{
-These functions support the comparison of results and
-timings across multiple sources.
+These functions support the comparison of results and timings across
+multiple sources.
 }
 \examples{
 if (require("Lahman") && require("microbenchmark")) {

diff --git a/man/build_sql.Rd b/man/build_sql.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{build_sql}
 \alias{build_sql}
 \title{Build a SQL string.}
@@ -17,13 +18,11 @@ build_sql(..., .env = parent.frame(), con = NULL)
   quoting characters.}
 }
 \description{
-This is a convenience function that should prevent sql
-injection attacks (which in the context of dplyr are most
-likely to be accidental not deliberate) by automatically
-escaping all expressions in the input, while treating bare
-strings as sql. This is unlikely to prevent any serious
-attack, but should make it unlikely that you produce
-invalid sql.
+This is a convenience function that should prevent sql injection attacks
+(which in the context of dplyr are most likely to be accidental not
+deliberate) by automatically escaping all expressions in the input, while
+treating bare strings as sql. This is unlikely to prevent any serious
+attack, but should make it unlikely that you produce invalid sql.
 }
 \examples{
 build_sql("SELECT * FROM TABLE")

diff --git a/man/cbind_list.Rd b/man/cbind_list.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{cbind_list}
 \alias{cbind_list}
 \title{Efficiently cbind multiple data frames.}

diff --git a/man/chain.Rd b/man/chain.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{chain}
 \alias{\%.\%}
 \alias{chain}
@@ -25,18 +26,15 @@ x \%.\% y
   set this parameter.}
 }
 \description{
-The downside of the functional nature of dplyr is that when
-you combine multiple data manipulation operations, you have
-to read from the inside out and the arguments may be very
-distant to the function call. These functions providing an
-alternative way of calling dplyr (and other data
-manipulation) functions that you read can from left to
-right.
+The downside of the functional nature of dplyr is that when you combine
+multiple data manipulation operations, you have to read from the inside
+out and the arguments may be very distant to the function call. These
+functions providing an alternative way of calling dplyr (and other data
+manipulation) functions that you read can from left to right.
 }
 \details{
-The functions work via simple substitution so that
-\code{chain(x, f(y))} or \code{x \%.\% f(y)} is translated
-into \code{f(x, y)}.
+The functions work via simple substitution so that \code{chain(x, f(y))} or
+\code{x \%.\% f(y)} is translated into \code{f(x, y)}.
 }
 \examples{
 if (require("hflights")) {

diff --git a/man/compute.Rd b/man/compute.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{compute}
 \alias{collapse}
 \alias{collect}
@@ -18,12 +19,11 @@ collapse(x, ...)
   \item{...}{other arguments passed on to methods}
 }
 \description{
-\code{compute} forces computation of lazy tbls, leaving
-data in the remote source. \code{collect} also forces
-computation, but will bring data back into an R data.frame
-(stored in a \code{\link{tbl_df}}). \code{collapse} doesn't
-force computation, but collapses a complex tbl into a form
-that additional restrictions can be placed on.
+\code{compute} forces computation of lazy tbls, leaving data in the remote
+source. \code{collect} also forces computation, but will bring data back into
+an R data.frame (stored in a \code{\link{tbl_df}}). \code{collapse} doesn't
+force computation, but collapses a complex tbl into a form that additional
+restrictions can be placed on.
 }
 \section{Grouping}{
   \code{compute} and \code{collect} preserve grouping,
@@ -42,7 +42,6 @@ local  <- collect(remote)
 }
 \seealso{
 \code{\link{copy_to}} which is the conceptual opposite: it
-takes a local data frame and makes it available to the
-remote source.
+  takes a local data frame and makes it available to the remote source.
 }
 
diff --git a/man/copy_to.Rd b/man/copy_to.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{copy_to}
 \alias{copy_to}
 \title{Copy a local data frame to a remote src.}
@@ -17,9 +18,8 @@ copy_to(dest, df, name = deparse(substitute(df)), ...)
 a \code{tbl} object in the remote source
 }
 \description{
-This uploads a local data frame into a remote data source,
-creating the table definition as needed. Wherever possible,
-the new object will be temporary, limited to the current
-connection to the source.
+This uploads a local data frame into a remote data source, creating the
+table definition as needed. Wherever possible, the new object will be
+temporary, limited to the current connection to the source.
 }
 
diff --git a/man/copy_to.src_sql.Rd b/man/copy_to.src_sql.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{copy_to.src_sql}
 \alias{copy_to.src_sql}
 \title{Copy a local data fram to a sqlite src.}

diff --git a/man/cumall.Rd b/man/cumall.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{cumall}
 \alias{cumall}
 \alias{cumany}
@@ -15,8 +16,8 @@ cummean(x)
   vector; for \code{cummean} an integer or numeric vector}
 }
 \description{
-dplyr adds \code{cumall}, \code{cumany}, and \code{cummean}
-to complete R's set of cumulate functions to match the
-aggregation functions available in most databases
+dplyr adds \code{cumall}, \code{cumany}, and \code{cummean} to complete
+R's set of cumulate functions to match the aggregation functions available
+in most databases
 }
 
diff --git a/man/desc.Rd b/man/desc.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{desc}
 \alias{desc}
 \title{Descending order.}
@@ -8,8 +9,7 @@ desc(x)
   \item{x}{vector to transform}
 }
 \description{
-Transform a vector into a format that will be sorted in
-descending order.
+Transform a vector into a format that will be sorted in descending order.
 }
 \examples{
 desc(1:10)

diff --git a/man/do.Rd b/man/do.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{do}
 \alias{do}
 \alias{do.tbl_sql}
@@ -23,9 +24,8 @@ do(.data, .f, ...)
   of talking to the database.}
 }
 \description{
-This is a general purpose complement to the specialised
-manipulation functions \code{\link{filter}},
-\code{\link{select}}, \code{\link{mutate}},
+This is a general purpose complement to the specialised manipulation
+functions \code{\link{filter}}, \code{\link{select}}, \code{\link{mutate}},
 \code{\link{summarise}} and \code{\link{arrange}}.
 }
 \examples{

diff --git a/man/dplyr-formatting.Rd b/man/dplyr-formatting.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{dplyr-formatting}
 \alias{dim_desc}
 \alias{dplyr-formatting}

diff --git a/man/dplyr.Rd b/man/dplyr.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \docType{package}
 \name{dplyr}
 \alias{dplyr}

diff --git a/man/explain_sql.Rd b/man/explain_sql.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{explain_sql}
 \alias{explain}
 \alias{explain_sql}
@@ -17,11 +18,10 @@ explain(tbl)
   \item{tbl}{an sql-based table to explain.}
 }
 \description{
-Any queries run inside this function will automatically be
-explained: displaying information about which indexes are
-used to optimise the query. This requires a little bit of
-knowledge about how \code{EXPLAIN} works for your database,
-but is very useful for diagnosing performance problems.
+Any queries run inside this function will automatically be explained:
+displaying information about which indexes are used to optimise the query.
+This requires a little bit of knowledge about how \code{EXPLAIN} works for
+your database, but is very useful for diagnosing performance problems.
 }
 \examples{
 \donttest{

diff --git a/man/failwith.Rd b/man/failwith.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{failwith}
 \alias{failwith}
 \title{Fail with specified value.}
@@ -15,8 +16,8 @@ failwith(default = NULL, f, quiet = FALSE)
 a function
 }
 \description{
-Modify a function so that it returns a default value when
-there is an error.
+Modify a function so that it returns a default value when there is an
+error.
 }
 \examples{
 f <- function(x) if (x == 1) stop("Error!") else 1

diff --git a/man/group_by.Rd b/man/group_by.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{group_by}
 \alias{group_by}
 \title{Group a tbl by one or more variables.}
@@ -17,10 +18,10 @@ group_by(x, ..., add = TRUE)
   FALSE}}
 }
 \description{
-Most data operations are useful done on groups defined by
-variables in the the dataset. The \code{group_by} function
-takes an existing tbl and converts it into a grouped tbl
-where operations are performed "by group".
+Most data operations are useful done on groups defined by variables in the
+the dataset. The \code{group_by} function takes an existing tbl
+and converts it into a grouped tbl where operations are performed
+"by group".
 }
 \section{Tbl types}{
   \code{group_by} is an S3 generic with methods for the
@@ -58,7 +59,6 @@ groups(group_by(by_cyl, cyl, cyl))
 }
 \seealso{
 \code{\link{ungroup}} for the inverse operation,
-\code{\link{group}} for accessors that don't do special
-evaluation.
+  \code{\link{group}} for accessors that don't do special evaluation.
 }
 
diff --git a/man/group_size.Rd b/man/group_size.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{group_size}
 \alias{group_size}
 \title{Calculate the size of each group}

diff --git a/man/grouped_df.Rd b/man/grouped_df.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{grouped_df}
 \alias{grouped_df}
 \alias{is.grouped_df}
@@ -16,10 +17,9 @@ is.grouped_df(x)
   even those without data.}
 }
 \description{
-The easiest way to create a grouped data frame is to call
-the \code{group_by} method on a data frame or tbl: this
-will take care of capturing the unevalated expressions for
-you.
+The easiest way to create a grouped data frame is to call the \code{group_by}
+method on a data frame or tbl: this will take care of capturing
+the unevalated expressions for you.
 }
 \keyword{internal}
 
diff --git a/man/grouped_dt.Rd b/man/grouped_dt.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{grouped_dt}
 \alias{grouped_dt}
 \alias{is.grouped_dt}
@@ -15,10 +16,9 @@ is.grouped_dt(x)
   \item{x}{an object to check}
 }
 \description{
-The easiest way to create a grouped data table is to call
-the \code{group_by} method on a data table or tbl: this
-will take care of capturing the unevalated expressions for
-you.
+The easiest way to create a grouped data table is to call the \code{group_by}
+method on a data table or tbl: this will take care of capturing
+the unevalated expressions for you.
 }
 \examples{
 if (require("hflights")) {

diff --git a/man/groups.Rd b/man/groups.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{groups}
 \alias{groups}
 \alias{regroup}
@@ -16,10 +17,9 @@ ungroup(x)
   \item{value}{a list of symbols}
 }
 \description{
-These functions do not perform non-standard evaluation, and
-so are useful when programming against \code{tbl} objects.
-\code{ungroup} is a convenient inline way of removing
-existing grouping.
+These functions do not perform non-standard evaluation, and so are useful
+when programming against \code{tbl} objects. \code{ungroup} is a convenient
+inline way of removing existing grouping.
 }
 \examples{
 grouped <- group_by(mtcars, cyl)
@@ -30,6 +30,6 @@ groups(ungroup(grouped))
 }
 \seealso{
 \code{\link{group_by}} for a version that does non-standard
-evaluation to save typing
+  evaluation to save typing
 }