From b457bab5cf341d837df6c2f43552c8ff4d9ef2f8 Mon Sep 17 00:00:00 2001 From: Jonathan Kitt Date: Fri, 11 Apr 2025 16:25:30 +0200 Subject: [PATCH 1/7] use palmerpenguins::penguins dataset for the arrange function doc --- .gitignore | 1 + R/arrange.R | 29 ++++++++++++++++++++--------- dplyr.Rproj | 1 + man/arrange.Rd | 28 +++++++++++++++++++--------- 4 files changed, 41 insertions(+), 18 deletions(-) diff --git a/.gitignore b/.gitignore index 599ed3d959..555f9443da 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,4 @@ doc Meta compile_commands.json .cache +*.Rproj diff --git a/R/arrange.R b/R/arrange.R index 4afa2a72ce..9a7806a5aa 100644 --- a/R/arrange.R +++ b/R/arrange.R @@ -59,14 +59,24 @@ #' help page under the `Default locale` section. #' @family single table verbs #' @examples -#' arrange(mtcars, cyl, disp) -#' arrange(mtcars, desc(disp)) +#' # Load the {palmerpenguins} package (R < 4.5.0) +#' library(palmerpenguins) #' -#' # grouped arrange ignores groups -#' by_cyl <- mtcars %>% group_by(cyl) -#' by_cyl %>% arrange(desc(wt)) +#' # Arrange by increasing order of bill depth +#' arrange(penguins, bill_depth_mm) +#' +#' # Arrange by increasing order of bill depth and body mass +#' arrange(penguins, bill_depth_mm, body_mass_g) +#' +#' # Arrange by increasing order of bill depth and decreasing order of body mass +#' arrange(penguins, bill_depth_mm, desc(body_mass_g)) +#' +#' # Grouped arrange ignores groups +#' by_species <- penguins %>% group_by(species) +#' by_species %>% arrange(desc(flipper_length_mm)) + #' # Unless you specifically ask: -#' by_cyl %>% arrange(desc(wt), .by_group = TRUE) +#' by_species %>% arrange(desc(flipper_length_mm), .by_group = TRUE) #' #' # use embracing when wrapping in a function; #' # see ?rlang::args_data_masking for more details @@ -74,11 +84,12 @@ #' .data %>% #' arrange({{ var }}) #' } -#' tidy_eval_arrange(mtcars, mpg) +#' tidy_eval_arrange(penguins, bill_length_mm) #' #' # Use `across()` or `pick()` to select columns with tidy-select -#' iris %>% arrange(pick(starts_with("Sepal"))) -#' iris %>% arrange(across(starts_with("Sepal"), desc)) +#' penguins %>% arrange(pick(contains("depth"))) +#' penguins %>% arrange(across(ends_with("mm"), desc)) +#' arrange <- function(.data, ..., .by_group = FALSE) { UseMethod("arrange") } diff --git a/dplyr.Rproj b/dplyr.Rproj index 4d650df928..be4b0046d2 100644 --- a/dplyr.Rproj +++ b/dplyr.Rproj @@ -1,4 +1,5 @@ Version: 1.0 +ProjectId: 0223743b-bfb8-4b54-bb6c-1b278ea360c9 RestoreWorkspace: Default SaveWorkspace: Default diff --git a/man/arrange.Rd b/man/arrange.Rd index d004c2e303..b7bc8a1634 100644 --- a/man/arrange.Rd +++ b/man/arrange.Rd @@ -79,14 +79,23 @@ The following methods are currently available in loaded packages: } \examples{ -arrange(mtcars, cyl, disp) -arrange(mtcars, desc(disp)) +# Load the {palmerpenguins} package (R < 4.5.0) +library(palmerpenguins) -# grouped arrange ignores groups -by_cyl <- mtcars \%>\% group_by(cyl) -by_cyl \%>\% arrange(desc(wt)) +# Arrange by increasing order of bill depth +arrange(penguins, bill_depth_mm) + +# Arrange by increasing order of bill depth and body mass +arrange(penguins, bill_depth_mm, body_mass_g) + +# Arrange by increasing order of bill depth and decreasing order of body mass +arrange(penguins, bill_depth_mm, desc(body_mass_g)) + +# Grouped arrange ignores groups +by_species <- penguins \%>\% group_by(species) +by_species \%>\% arrange(desc(flipper_length_mm)) # Unless you specifically ask: -by_cyl \%>\% arrange(desc(wt), .by_group = TRUE) +by_species \%>\% arrange(desc(flipper_length_mm), .by_group = TRUE) # use embracing when wrapping in a function; # see ?rlang::args_data_masking for more details @@ -94,11 +103,12 @@ tidy_eval_arrange <- function(.data, var) { .data \%>\% arrange({{ var }}) } -tidy_eval_arrange(mtcars, mpg) +tidy_eval_arrange(penguins, bill_length_mm) # Use `across()` or `pick()` to select columns with tidy-select -iris \%>\% arrange(pick(starts_with("Sepal"))) -iris \%>\% arrange(across(starts_with("Sepal"), desc)) +penguins \%>\% arrange(pick(contains("depth"))) +penguins \%>\% arrange(across(ends_with("mm"), desc)) + } \seealso{ Other single table verbs: From 812e1ddcffcc5f9ba8dd5098e63e84e0fd67ba76 Mon Sep 17 00:00:00 2001 From: Jonathan Kitt Date: Mon, 14 Apr 2025 09:29:57 +0200 Subject: [PATCH 2/7] add palmerpenguins to DESCRIPTION (suggests paragraph) + re-run install, test & check --- DESCRIPTION | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 49f92c88cc..e77e606ff1 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -56,7 +56,8 @@ Suggests: stringi (>= 1.7.6), testthat (>= 3.1.5), tidyr (>= 1.3.0), - withr + withr, + palmerpenguins VignetteBuilder: knitr Config/Needs/website: tidyverse, shiny, pkgdown, tidyverse/tidytemplate From deb6ae7d02b2f3f7651fb248ebce047400f1c30e Mon Sep 17 00:00:00 2001 From: Jonathan Kitt Date: Tue, 15 Apr 2025 16:11:02 +0200 Subject: [PATCH 3/7] Update R/arrange.R Co-authored-by: Davis Vaughan --- R/arrange.R | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/R/arrange.R b/R/arrange.R index 9a7806a5aa..48e46f5f24 100644 --- a/R/arrange.R +++ b/R/arrange.R @@ -63,13 +63,13 @@ #' library(palmerpenguins) #' #' # Arrange by increasing order of bill depth -#' arrange(penguins, bill_depth_mm) +#' penguins %>% arrange(bill_depth_mm) #' #' # Arrange by increasing order of bill depth and body mass -#' arrange(penguins, bill_depth_mm, body_mass_g) +#' penguins %>% arrange(bill_depth_mm, body_mass_g) #' #' # Arrange by increasing order of bill depth and decreasing order of body mass -#' arrange(penguins, bill_depth_mm, desc(body_mass_g)) +#' penguins %>% arrange(bill_depth_mm, desc(body_mass_g)) #' #' # Grouped arrange ignores groups #' by_species <- penguins %>% group_by(species) From efbb2d8ac8419e74600208168a017967ea3dabc0 Mon Sep 17 00:00:00 2001 From: Jonathan Kitt Date: Wed, 16 Apr 2025 11:37:04 +0200 Subject: [PATCH 4/7] move {palmerpenguins}from suggests to imports + use data() rather than library() + use primary pipe examples --- DESCRIPTION | 4 ++-- R/arrange.R | 4 ++-- man/arrange.Rd | 10 +++++----- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index e77e606ff1..ebf5fe5789 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -34,7 +34,8 @@ Imports: tibble (>= 3.2.0), tidyselect (>= 1.2.0), utils, - vctrs (>= 0.6.4) + vctrs (>= 0.6.4), + palmerpenguins Suggests: bench, broom, @@ -57,7 +58,6 @@ Suggests: testthat (>= 3.1.5), tidyr (>= 1.3.0), withr, - palmerpenguins VignetteBuilder: knitr Config/Needs/website: tidyverse, shiny, pkgdown, tidyverse/tidytemplate diff --git a/R/arrange.R b/R/arrange.R index 48e46f5f24..82a030f6cf 100644 --- a/R/arrange.R +++ b/R/arrange.R @@ -59,8 +59,8 @@ #' help page under the `Default locale` section. #' @family single table verbs #' @examples -#' # Load the {palmerpenguins} package (R < 4.5.0) -#' library(palmerpenguins) +#' # Load the 'penguins' data set from {palmerpenguins} package (R < 4.5.0) +#' data("penguins") #' #' # Arrange by increasing order of bill depth #' penguins %>% arrange(bill_depth_mm) diff --git a/man/arrange.Rd b/man/arrange.Rd index b7bc8a1634..78359ed833 100644 --- a/man/arrange.Rd +++ b/man/arrange.Rd @@ -79,17 +79,17 @@ The following methods are currently available in loaded packages: } \examples{ -# Load the {palmerpenguins} package (R < 4.5.0) -library(palmerpenguins) +# Load the 'penguins' data set from {palmerpenguins} package (R < 4.5.0) +data("penguins") # Arrange by increasing order of bill depth -arrange(penguins, bill_depth_mm) +penguins \%>\% arrange(bill_depth_mm) # Arrange by increasing order of bill depth and body mass -arrange(penguins, bill_depth_mm, body_mass_g) +penguins \%>\% arrange(bill_depth_mm, body_mass_g) # Arrange by increasing order of bill depth and decreasing order of body mass -arrange(penguins, bill_depth_mm, desc(body_mass_g)) +penguins \%>\% arrange(bill_depth_mm, desc(body_mass_g)) # Grouped arrange ignores groups by_species <- penguins \%>\% group_by(species) From 25754962bb9b35205a844314ad1341a7124130d1 Mon Sep 17 00:00:00 2001 From: Jonathan Kitt Date: Wed, 16 Apr 2025 15:25:42 +0200 Subject: [PATCH 5/7] Simplify the data loading comment Co-authored-by: Hadley Wickham --- R/arrange.R | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/R/arrange.R b/R/arrange.R index 82a030f6cf..67d39c6026 100644 --- a/R/arrange.R +++ b/R/arrange.R @@ -59,8 +59,7 @@ #' help page under the `Default locale` section. #' @family single table verbs #' @examples -#' # Load the 'penguins' data set from {palmerpenguins} package (R < 4.5.0) -#' data("penguins") +#' data("penguins", package = "palmerpenguins") #' #' # Arrange by increasing order of bill depth #' penguins %>% arrange(bill_depth_mm) From c17814fe1b32046995ed27b54b6895a5d765ff84 Mon Sep 17 00:00:00 2001 From: Jonathan Kitt Date: Wed, 16 Apr 2025 15:27:50 +0200 Subject: [PATCH 6/7] Update DESCRIPTION Co-authored-by: Hadley Wickham --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index ebf5fe5789..1aba498296 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -57,7 +57,7 @@ Suggests: stringi (>= 1.7.6), testthat (>= 3.1.5), tidyr (>= 1.3.0), - withr, + withr VignetteBuilder: knitr Config/Needs/website: tidyverse, shiny, pkgdown, tidyverse/tidytemplate From ba4e9cd72036d6629d489d208c67e3eeea6debae Mon Sep 17 00:00:00 2001 From: Jonathan Kitt Date: Wed, 16 Apr 2025 15:36:27 +0200 Subject: [PATCH 7/7] - remove unnecessary comments - update DESCRIPTION to preserver alphabetical order - remove unrelated file from .gitignore --- .gitignore | 1 - DESCRIPTION | 4 ++-- R/arrange.R | 6 ++---- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index 555f9443da..599ed3d959 100644 --- a/.gitignore +++ b/.gitignore @@ -25,4 +25,3 @@ doc Meta compile_commands.json .cache -*.Rproj diff --git a/DESCRIPTION b/DESCRIPTION index 1aba498296..d4493a2b46 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -28,14 +28,14 @@ Imports: lifecycle (>= 1.0.3), magrittr (>= 1.5), methods, + palmerpenguins, pillar (>= 1.9.0), R6, rlang (>= 1.1.3), tibble (>= 3.2.0), tidyselect (>= 1.2.0), utils, - vctrs (>= 0.6.4), - palmerpenguins + vctrs (>= 0.6.4) Suggests: bench, broom, diff --git a/R/arrange.R b/R/arrange.R index 67d39c6026..706937a4d6 100644 --- a/R/arrange.R +++ b/R/arrange.R @@ -61,13 +61,11 @@ #' @examples #' data("penguins", package = "palmerpenguins") #' -#' # Arrange by increasing order of bill depth +#' # Arrange by increasing order #' penguins %>% arrange(bill_depth_mm) -#' -#' # Arrange by increasing order of bill depth and body mass #' penguins %>% arrange(bill_depth_mm, body_mass_g) #' -#' # Arrange by increasing order of bill depth and decreasing order of body mass +#' # Mix sorting by increasing and decreasing order #' penguins %>% arrange(bill_depth_mm, desc(body_mass_g)) #' #' # Grouped arrange ignores groups