thisisnic commented on code in PR #14014: URL: https://github.com/apache/arrow/pull/14014#discussion_r969343881
########## r/R/dplyr-funcs-doc.R: ########## @@ -0,0 +1,331 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +# Generated by using data-raw/docgen.R -> do not edit by hand + +#' Functions available in Arrow dplyr queries +#' +#' The `arrow` package contains methods for 32 `dplyr` table functions, many of +#' which are "verbs" that do transformations to one or more tables. +#' The package also has mappings of 204 R functions to the corresponding +#' functions in the Arrow compute library. These allow you to write code inside +#' of `dplyr` methods that call R functions, including many in packages like +#' `stringr` and `lubridate`, and they will get translated to Arrow and run +#' on the Arrow query engine (Acero). This document lists all of the mapped +#' functions. +#' +#' # `dplyr` verbs +#' +#' Most verb functions return an `arrow_dplyr_query` object, similar in spirit +#' to a `dbplyr::tbl_lazy`. This means that the verbs do not eagerly evaluate +#' the query on the data. To run the query, call either `compute()`, +#' which returns an `arrow` [Table], or `collect()`, which pulls the resulting +#' Table into an R `data.frame`. +#' +#' * [anti_join][dplyr::anti_join()] +#' * [arrange][dplyr::arrange()] +#' * [collapse][dplyr::collapse()] +#' * [collect][dplyr::collect()] +#' * [compute][dplyr::compute()] +#' * [count][dplyr::count()] +#' * [distinct][dplyr::distinct()] +#' * [explain][dplyr::explain()] +#' * [filter][dplyr::filter()] +#' * [full_join][dplyr::full_join()] +#' * [glimpse][dplyr::glimpse()] +#' * [group_by][dplyr::group_by()] +#' * [group_by_drop_default][dplyr::group_by_drop_default()] +#' * [group_vars][dplyr::group_vars()] +#' * [groups][dplyr::groups()] +#' * [inner_join][dplyr::inner_join()] +#' * [left_join][dplyr::left_join()] +#' * [mutate][dplyr::mutate()] +#' * [pull][dplyr::pull()] +#' * [relocate][dplyr::relocate()] +#' * [rename][dplyr::rename()] +#' * [rename_with][dplyr::rename_with()] +#' * [right_join][dplyr::right_join()] +#' * [select][dplyr::select()] +#' * [semi_join][dplyr::semi_join()] +#' * [show_query][dplyr::show_query()] +#' * [summarise][dplyr::summarise()] +#' * [tally][dplyr::tally()] +#' * [transmute][dplyr::transmute()] +#' * [ungroup][dplyr::ungroup()] +#' * [union][dplyr::union()] +#' * [union_all][dplyr::union_all()] +#' +#' # Function mappings +#' +#' In the list below, any differences in behavior or support between Acero and +#' the R function are listed. If no notes follow the function name, then you +#' can assume that the function works in Acero just as it does in R. +#' +#' Functions can be called either as `pkg::fun()` or just `fun()`, i.e. both +#' `str_sub()` and `stringr::str_sub()` work. +#' +#' In addition to these functions, you can call any of Arrow's 243 compute +#' functions directly. Arrow has many functions that don't map to an existing R +#' function. In other cases where there is an R function mapping, you can still +#' call the Arrow function directly if you don't want the adaptations that the R +#' mapping has that make Acero behave like R. These functions are listed in the +#' [C++ documentation](https://arrow.apache.org/docs/cpp/compute.html), and +#' in the function registry in R, they are named with an `arrow_` prefix, such +#' as `arrow_ascii_is_decimal`. +#' +#' ## arrow +#' +#' * [add_filename][arrow::add_filename()] +#' * [cast][arrow::cast()] +#' +#' ## base +#' +#' * [-][-()] +#' * [!][!()] +#' * [!=][!=()] +#' * [*][*()] +#' * [/][/()] +#' * [&][&()] +#' * [%/%][%/%()] +#' * [%%][%%()] +#' * [%in%][%in%()] +#' * [^][^()] +#' * [+][+()] +#' * [<][<()] +#' * [<=][<=()] +#' * [==][==()] +#' * [>][>()] +#' * [>=][>=()] +#' * [|][|()] +#' * [abs][base::abs()] +#' * [acos][base::acos()] +#' * [all][base::all()] +#' * [any][base::any()] +#' * [as.character][base::as.character()] +#' * [as.Date][base::as.Date()] +#' * [as.difftime][base::as.difftime()] +#' * [as.double][base::as.double()] +#' * [as.integer][base::as.integer()] +#' * [as.logical][base::as.logical()] +#' * [as.numeric][base::as.numeric()] +#' * [asin][base::asin()] +#' * [ceiling][base::ceiling()] +#' * [cos][base::cos()] +#' * [data.frame][base::data.frame()] +#' * [difftime][base::difftime()] +#' * [endsWith][base::endsWith()] +#' * [exp][base::exp()] +#' * [floor][base::floor()] +#' * [format][base::format()] +#' * [grepl][base::grepl()] +#' * [gsub][base::gsub()] +#' * [ifelse][base::ifelse()] +#' * [is.character][base::is.character()] +#' * [is.double][base::is.double()] +#' * [is.factor][base::is.factor()] +#' * [is.finite][base::is.finite()] +#' * [is.infinite][base::is.infinite()] +#' * [is.integer][base::is.integer()] +#' * [is.list][base::is.list()] +#' * [is.logical][base::is.logical()] +#' * [is.na][base::is.na()] +#' * [is.nan][base::is.nan()] +#' * [is.numeric][base::is.numeric()] +#' * [ISOdate][base::ISOdate()] +#' * [ISOdatetime][base::ISOdatetime()] +#' * [log][base::log()] +#' * [log10][base::log10()] +#' * [log1p][base::log1p()] +#' * [log2][base::log2()] +#' * [logb][base::logb()] +#' * [max][base::max()] +#' * [mean][base::mean()] +#' * [min][base::min()] +#' * [nchar][base::nchar()] +#' * [paste][base::paste()]: the `collapse` argument is not yet supported +#' * [paste0][base::paste0()]: the `collapse` argument is not yet supported +#' * [pmax][base::pmax()] +#' * [pmin][base::pmin()] +#' * [round][base::round()] +#' * [sign][base::sign()] +#' * [sin][base::sin()] +#' * [sqrt][base::sqrt()] +#' * [startsWith][base::startsWith()] +#' * [strftime][base::strftime()] +#' * [strptime][base::strptime()] +#' * [strrep][base::strrep()] +#' * [strsplit][base::strsplit()] +#' * [sub][base::sub()] +#' * [substr][base::substr()] +#' * [substring][base::substring()] +#' * [sum][base::sum()] +#' * [tan][base::tan()] +#' * [tolower][base::tolower()] +#' * [toupper][base::toupper()] +#' * [trunc][base::trunc()] +#' +#' ## bit64 +#' +#' * [as.integer64][bit64::as.integer64()] +#' * [is.integer64][bit64::is.integer64()] +#' +#' ## dplyr +#' +#' * [across][dplyr::across()]: only supported inside `mutate()`; purrr-style lambda functions not yet supported Review Comment: ```suggestion #' * [across][dplyr::across()]: only supported inside `mutate()`, `summarize()` and `arrange()`; purrr-style lambda functions not yet supported ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
