Merge pull request #225 from SebKrantz/development

Update NEWS regarding #221, also on the website.
SebKrantz · Feb 5, 2022 · 24f06e4 · 24f06e4
2 parents ea4fb4e + 71f17d0
commit 24f06e4
Show file tree

Hide file tree

Showing 25 changed files with 49 additions and 47 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,6 @@
 # collapse 1.7.5
 
-* In the development version on GitHub, a `.` was added to the first argument of functions `fselect`, `fsubset`, `colorder` and `fgroup_by`, i.e. `fselect(x, ...) -> fselect(.x, ...)`. The reason for this is that over time I added the option to select-rename columns e.g. `fselect(mtcars, cylinders = cyl)`, which was not offered when these functions were created. This presents problems if columns should be renamed into `x`, e.g. `fselect(mtcars, x = cyl)` fails, see e.g. #221 . Renaming the argument to `.x` somewhat guards against such situations. I think this API change is worthwhile to implement, because it makes the package more robust going forward, and usually the first argument of these functions is never invoked explicitly. For now it remains in the development version which you can install using `remotes::install_github("SebKrantz/collapse")`. If you have strong objections to this change (because it will break your code or you know of people that have a programming style where they explicitly set the first argument of data manipulation functions), please let me know!  
+* In the development version on GitHub, a `.` was added to the first argument of functions `fselect`, `fsubset`, `colorder` and `fgroup_by`, i.e. `fselect(x, ...) -> fselect(.x, ...)`. The reason for this is that over time I added the option to select-rename columns e.g. `fselect(mtcars, cylinders = cyl)`, which was not offered when these functions were created. This presents problems if columns should be renamed into `x`, e.g. `fselect(mtcars, x = cyl)` fails, see e.g. [#221](https://github.com/SebKrantz/collapse/issues/221) . Renaming the first argument to `.x` somewhat guards against such situations. I think this API change is worthwhile to implement, because it makes the package more robust going forward, and usually the first argument of these functions is never invoked explicitly. For now it remains in the development version which you can install using `remotes::install_github("SebKrantz/collapse")`. If you have strong objections to this change (because it will break your code or you know of people that have a programming style where they explicitly set the first argument of data manipulation functions), please let me know!  
 
 * Also ensuring tidyverse examples are in `\donttest{}` and building without the *dplyr* testing file to avoid issues with static code analysis on CRAN.
 

diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/reference/TRA.html b/docs/reference/TRA.html
diff --git a/docs/reference/across.html b/docs/reference/across.html
diff --git a/docs/reference/collapse-package.html b/docs/reference/collapse-package.html
diff --git a/docs/reference/colorder.html b/docs/reference/colorder.html
diff --git a/docs/reference/descr.html b/docs/reference/descr.html
diff --git a/docs/reference/fFtest.html b/docs/reference/fFtest.html
diff --git a/docs/reference/fbetween_fwithin.html b/docs/reference/fbetween_fwithin.html
diff --git a/docs/reference/flm.html b/docs/reference/flm.html
diff --git a/docs/reference/fmean.html b/docs/reference/fmean.html
diff --git a/docs/reference/fmedian.html b/docs/reference/fmedian.html
diff --git a/docs/reference/fndistinct.html b/docs/reference/fndistinct.html
diff --git a/docs/reference/fprod.html b/docs/reference/fprod.html
diff --git a/docs/reference/funique.html b/docs/reference/funique.html
diff --git a/docs/reference/groupid.html b/docs/reference/groupid.html
diff --git a/docs/reference/pad.html b/docs/reference/pad.html
diff --git a/docs/reference/psacf.html b/docs/reference/psacf.html
diff --git a/docs/reference/radixorder.html b/docs/reference/radixorder.html
diff --git a/docs/reference/rapply2d.html b/docs/reference/rapply2d.html
diff --git a/docs/reference/roworder.html b/docs/reference/roworder.html
diff --git a/docs/reference/rsplit.html b/docs/reference/rsplit.html
diff --git a/docs/reference/select_replace_vars.html b/docs/reference/select_replace_vars.html
diff --git a/docs/reference/small-helper.html b/docs/reference/small-helper.html
diff --git a/docs/reference/varying.html b/docs/reference/varying.html