Skip to content

Commit 3c9236d

Browse files
nealrichardsonfsaintjacques
authored andcommitted
ARROW-6183: [R] Document that you don't have to use tidyselect if you don't want
Closes #5144 from nealrichardson/col-select-docs and squashes the following commits: 2b344cb <Neal Richardson> Document that col_select takes a character vector too Authored-by: Neal Richardson <neal.p.richardson@gmail.com> Signed-off-by: François Saint-Jacques <fsaintjacques@gmail.com>
1 parent f413c8f commit 3c9236d

6 files changed

Lines changed: 19 additions & 8 deletions

File tree

r/R/csv.R

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@
4646
#' column names and will not be included in the data frame. (Note that `FALSE`
4747
#' is not currently supported.) Alternatively, you can specify a character
4848
#' vector of column names.
49-
#' @param col_select A [tidy selection specification][tidyselect::vars_select]
49+
#' @param col_select A character vector of column names to keep, as in the
50+
#' "select" argument to `data.table::fread()`, or a
51+
#' [tidy selection specification][tidyselect::vars_select()]
5052
#' of columns, as used in `dplyr::select()`.
5153
#' @param skip_empty_rows Should blank rows be ignored altogether? If
5254
#' `TRUE`, blank rows will not be represented at all. If `FALSE`, they will be

r/R/feather.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,7 @@ FeatherTableReader.raw <- function(file, mmap = TRUE, ...) {
170170
#' Read a Feather file
171171
#'
172172
#' @param file an `arrow::ipc::feather::TableReader` or whatever the [FeatherTableReader()] function can handle
173-
#' @param col_select [tidy selection][tidyselect::vars_select()] of columns to read.
174-
#' @param as_tibble should the [arrow::Table][arrow__Table] be converted to a tibble.
173+
#' @inheritParams read_delim_arrow
175174
#' @param ... additional parameters
176175
#'
177176
#' @return A `data.frame` if `as_tibble` is `TRUE` (the default), or a [arrow::Table][arrow__Table] otherwise

r/man/read_delim_arrow.Rd

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r/man/read_feather.Rd

Lines changed: 6 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r/man/read_json_arrow.Rd

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r/man/read_parquet.Rd

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)