Update docs

sharlagelfand · Jan 1, 2015 · 9964293 · 9964293
1 parent 8b77bdc
commit 9964293
Show file tree

Hide file tree

Showing 89 changed files with 190 additions and 89 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,4 +1,4 @@
-# Generated by roxygen2 (4.0.2): do not edit by hand
+# Generated by roxygen2 (4.1.0): do not edit by hand
 
 S3method("[",grouped_df)
 S3method("[",tbl_df)

diff --git a/man/add_rownames.Rd b/man/add_rownames.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/dataframe.R
 \name{add_rownames}
 \alias{add_rownames}
 \title{Convert row names to an explicit variable.}

diff --git a/man/all.equal.tbl_df.Rd b/man/all.equal.tbl_df.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/all-equal.r
 \name{all.equal.tbl_df}
 \alias{all.equal.tbl_df}
 \alias{all.equal.tbl_dt}

diff --git a/man/arrange.Rd b/man/arrange.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/manip.r
 \name{arrange}
 \alias{arrange}
 \alias{arrange_}

diff --git a/man/as.tbl_cube.Rd b/man/as.tbl_cube.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/tbl-cube.r
 \name{as.tbl_cube}
 \alias{as.tbl_cube}
 \alias{as.tbl_cube.array}

diff --git a/man/as_data_frame.Rd b/man/as_data_frame.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/dataframe.R
 \name{as_data_frame}
 \alias{as_data_frame}
 \title{Coerce a list to a data frame.}

diff --git a/man/backend_db.Rd b/man/backend_db.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/dbi-s3.r
 \name{backend_db}
 \alias{backend_db}
 \alias{db_analyze}

diff --git a/man/backend_sql.Rd b/man/backend_sql.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/dbi-s3.r
 \name{backend_sql}
 \alias{backend_sql}
 \alias{sql_escape_ident}

diff --git a/man/backend_src.Rd b/man/backend_src.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/dbi-s3.r
 \name{backend_src}
 \alias{backend_src}
 \alias{src_desc}

diff --git a/man/bench_compare.Rd b/man/bench_compare.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/bench-compare.r
 \name{bench_compare}
 \alias{bench_compare}
 \alias{bench_tbls}

diff --git a/man/between.Rd b/man/between.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/RcppExports.R
 \name{between}
 \alias{between}
 \title{Do values in a numeric vector fall in specified range?}

diff --git a/man/bind.Rd b/man/bind.Rd
@@ -1,8 +1,10 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/RcppExports.R, R/rbind.r
 \name{rbind_all}
 \alias{bind}
 \alias{bind_cols}
 \alias{bind_rows}
+\alias{combine}
 \alias{rbind_all}
 \alias{rbind_list}
 \title{Efficiently bind multiple data frames by row and column.}
@@ -13,6 +15,8 @@ bind_rows(x, ...)
 
 bind_cols(x, ...)
 
+combine(x, ...)
+
 rbind_list(...)
 }
 \arguments{
@@ -32,7 +36,8 @@ rbind_list(...)
 \description{
 This is an efficient implementation of the common pattern of
 \code{do.call(rbind, dfs)} or \code{do.call{cbind, dfs}} for binding many
-data frames into one.
+data frames into one. \code{combine()} acts like \code{\link{c}()} or
+\code{\link{unlist}()} but uses consistent dplyr coercion rules.
 }
 \section{Deprecated functions}{
 
@@ -58,5 +63,14 @@ bind_cols(data.frame(x = 1), data.frame(y = 1:2))
 
 bind_cols(one, two)
 bind_cols(list(one, two))
+
+# combine applies the same coercion rules
+f1 <- factor("a")
+f2 <- factor("b")
+c(f1, f2)
+unlist(list(f1, f2))
+
+combine(f1, f2)
+combine(list(f1, f2))
 }
 
diff --git a/man/build_sql.Rd b/man/build_sql.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/sql-escape.r
 \name{build_sql}
 \alias{build_sql}
 \title{Build a SQL string.}

diff --git a/man/chain.Rd b/man/chain.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/chain.r
 \name{chain}
 \alias{\%.\%}
 \alias{\%>\%}

diff --git a/man/compute.Rd b/man/compute.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/compute-collect.r, R/tbl-sql.r
 \name{compute}
 \alias{collapse}
 \alias{collect}

diff --git a/man/copy_to.Rd b/man/copy_to.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/copy-to.r
 \name{copy_to}
 \alias{copy_to}
 \title{Copy a local data frame to a remote src.}

diff --git a/man/copy_to.src_sql.Rd b/man/copy_to.src_sql.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/tbl-sql.r
 \name{copy_to.src_sql}
 \alias{copy_to.src_sql}
 \title{Copy a local data frame to a sqlite src.}

diff --git a/man/cumall.Rd b/man/cumall.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/RcppExports.R
 \name{cumall}
 \alias{cumall}
 \alias{cumany}

diff --git a/man/data_frame.Rd b/man/data_frame.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/dataframe.R
 \name{data_frame}
 \alias{data_frame}
 \alias{data_frame_}

diff --git a/man/desc.Rd b/man/desc.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/desc.r
 \name{desc}
 \alias{desc}
 \title{Descending order.}

diff --git a/man/distinct.Rd b/man/distinct.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/distinct.R
 \name{distinct}
 \alias{distinct}
 \alias{distinct_}

diff --git a/man/do.Rd b/man/do.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/do.r, R/tbl-sql.r
 \name{do}
 \alias{do}
 \alias{do_}

diff --git a/man/dplyr-cluster.Rd b/man/dplyr-cluster.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/cluster.R
 \name{dplyr-cluster}
 \alias{dplyr-cluster}
 \alias{get_cluster}

diff --git a/man/dplyr-formatting.Rd b/man/dplyr-formatting.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/tbl-df.r, R/tbl-dt.r, R/tbl-sql.r, R/utils-format.r
 \name{print.tbl_df}
 \alias{dim_desc}
 \alias{dplyr-formatting}

diff --git a/man/dplyr.Rd b/man/dplyr.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/dplyr.r
 \docType{package}
 \name{dplyr}
 \alias{dplyr}

diff --git a/man/explain.Rd b/man/explain.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/explain.r
 \name{explain}
 \alias{explain}
 \alias{show_query}

diff --git a/man/failwith.Rd b/man/failwith.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/failwith.r
 \name{failwith}
 \alias{failwith}
 \title{Fail with specified value.}

diff --git a/man/filter.Rd b/man/filter.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/manip.r
 \name{filter}
 \alias{filter}
 \alias{filter_}

diff --git a/man/funs.Rd b/man/funs.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/funs.R
 \name{funs}
 \alias{funs}
 \alias{funs_}

diff --git a/man/glimpse.Rd b/man/glimpse.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/glimpse.R
 \name{glimpse}
 \alias{glimpse}
 \title{Get a glimpse of your data.}

diff --git a/man/group_by.Rd b/man/group_by.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/group-by.r
 \name{group_by}
 \alias{group_by}
 \alias{group_by_}

diff --git a/man/group_indices.Rd b/man/group_indices.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/group-indices.R
 \name{group_indices}
 \alias{group_indices}
 \alias{group_indices_}

diff --git a/man/group_size.Rd b/man/group_size.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/group-size.r
 \name{group_size}
 \alias{group_size}
 \alias{n_groups}

diff --git a/man/grouped_df.Rd b/man/grouped_df.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/grouped-df.r
 \name{grouped_df}
 \alias{grouped_df}
 \alias{is.grouped_df}

diff --git a/man/grouped_dt.Rd b/man/grouped_dt.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/grouped-dt.r
 \name{grouped_dt}
 \alias{grouped_dt}
 \alias{is.grouped_dt}

diff --git a/man/groups.Rd b/man/groups.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/group-by.r
 \name{groups}
 \alias{groups}
 \alias{ungroup}

diff --git a/man/id.Rd b/man/id.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/id.r
 \name{id}
 \alias{id}
 \title{Compute a unique numeric id for each unique row in a data frame.}

diff --git a/man/join.Rd b/man/join.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/join.r
 \name{join}
 \alias{anti_join}
 \alias{full_join}

diff --git a/man/join.tbl_df.Rd b/man/join.tbl_df.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/tbl-df.r
 \name{join.tbl_df}
 \alias{anti_join.tbl_df}
 \alias{full_join.tbl_df}

diff --git a/man/join.tbl_dt.Rd b/man/join.tbl_dt.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/tbl-dt.r
 \name{join.tbl_dt}
 \alias{anti_join.data.table}
 \alias{inner_join.data.table}

diff --git a/man/join.tbl_sql.Rd b/man/join.tbl_sql.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/tbl-sql.r
 \name{join.tbl_sql}
 \alias{anti_join.tbl_sql}
 \alias{inner_join.tbl_sql}

diff --git a/man/knit_print.trunc_mat.Rd b/man/knit_print.trunc_mat.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/utils-format.r
 \name{knit_print.trunc_mat}
 \alias{knit_print.trunc_mat}
 \title{knit_print method for trunc mat}

diff --git a/man/lahman.Rd b/man/lahman.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/data-lahman.r
 \name{lahman}
 \alias{copy_lahman}
 \alias{has_lahman}

diff --git a/man/lead-lag.Rd b/man/lead-lag.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/lead-lag.R
 \name{lead-lag}
 \alias{lag.default}
 \alias{lead}

diff --git a/man/location.Rd b/man/location.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/location.R
 \name{location}
 \alias{changes}
 \alias{location}

diff --git a/man/make_tbl.Rd b/man/make_tbl.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/tbl.r
 \name{make_tbl}
 \alias{make_tbl}
 \title{Create a "tbl" object}

diff --git a/man/mutate.Rd b/man/mutate.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/manip.r
 \name{mutate}
 \alias{mutate}
 \alias{mutate_}

diff --git a/man/n.Rd b/man/n.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/manip.r
 \name{n}
 \alias{n}
 \title{The number of observations in the current group.}

diff --git a/man/n_distinct.Rd b/man/n_distinct.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/RcppExports.R
 \name{n_distinct}
 \alias{n_distinct}
 \title{Efficiently count the number of unique values in a vector.}

diff --git a/man/nasa.Rd b/man/nasa.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/data-nasa.r
 \docType{data}
 \name{nasa}
 \alias{nasa}

diff --git a/man/nth.Rd b/man/nth.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/nth-value.R
 \name{nth}
 \alias{first}
 \alias{last}