Skip to content

ARROW-17665: [R] Document dplyr and compute functionality #14387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nealrichardson merged 7 commits into from
Oct 14, 2022
Merged

ARROW-17665: [R] Document dplyr and compute functionality #14387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7ac5578
Add notes for string functions; add ability for package-level notes i…
nealrichardson Oct 12, 2022
83cddff
Doc the rest of the functions
nealrichardson Oct 12, 2022
9ea129f
Update tests
nealrichardson Oct 12, 2022
0762190
Add dplyr method notes and agg functions
nealrichardson Oct 12, 2022
52abb0e
Add note about pull()
nealrichardson Oct 12, 2022
85e3bb4
Cleanups
nealrichardson Oct 13, 2022
d0622bf
Add note about join arguments
nealrichardson Oct 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions r/R/arrow-package.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,27 +38,33 @@ supported_dplyr_methods <- list(
select = NULL,
filter = NULL,
collect = NULL,
summarise = NULL,
summarise = c(
"window functions not currently supported;",
'arguments `.drop = FALSE` and `.groups = "rowwise" not supported'
),
group_by = NULL,
groups = NULL,
group_vars = NULL,
group_by_drop_default = NULL,
ungroup = NULL,
mutate = NULL,
mutate = c(
"window functions (e.g. things that require aggregation within groups)",
Copy link
Member

@thisisnic thisisnic Oct 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"window functions (e.g. things that require aggregation within groups)",
"window functions (i.e. things that require aggregation within groups)",

nit, but only if window functions are literally defined by this, which I wasn't sure about

Copy link
Member Author

@nealrichardson nealrichardson Oct 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Window functions are more than this, though this is in practice how you would trigger them inside mutate(). I'll leave it as is (if for no other reason than to save the CI cycles). Who knows, maybe I can make this work for 11.0 and we can remove the note altogether ;)

"not currently supported"
),
transmute = NULL,
arrange = NULL,
rename = NULL,
pull = NULL,
pull = "returns an Arrow [ChunkedArray], not an R vector",
relocate = NULL,
compute = NULL,
collapse = NULL,
distinct = NULL,
left_join = NULL,
right_join = NULL,
inner_join = NULL,
full_join = NULL,
semi_join = NULL,
anti_join = NULL,
distinct = "`.keep_all = TRUE` not supported",
left_join = "the `copy` and `na_matches` arguments are ignored",
right_join = "the `copy` and `na_matches` arguments are ignored",
inner_join = "the `copy` and `na_matches` arguments are ignored",
full_join = "the `copy` and `na_matches` arguments are ignored",
semi_join = "the `copy` and `na_matches` arguments are ignored",
anti_join = "the `copy` and `na_matches` arguments are ignored",
count = NULL,
tally = NULL,
rename_with = NULL,
Expand Down
Loading