| Version: | 0.3.2 |
| Title: | Tools for Working with ... |
| Description: | The ellipsis is a powerful tool for extending functions. Unfortunately this power comes at a cost: misspelled arguments will be silently ignored. The ellipsis package provides a collection of functions to catch problems and alert the user. |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.1.1 |
| URL: | https://ellipsis.r-lib.org, https://github.com/r-lib/ellipsis |
| BugReports: | https://github.com/r-lib/ellipsis/issues |
| Depends: | R (≥ 3.2) |
| Imports: | rlang (≥ 0.3.0) |
| Suggests: | covr, testthat |
| NeedsCompilation: | yes |
| Packaged: | 2021-04-29 12:06:44 UTC; lionel |
| Author: | Hadley Wickham [aut, cre], RStudio [cph] |
| Maintainer: | Hadley Wickham <hadley@rstudio.com> |
| Repository: | CRAN |
| Date/Publication: | 2021-04-29 12:40:02 UTC |
ellipsis: Tools for Working with ...
Description
The ellipsis is a powerful tool for extending functions. Unfortunately this power comes at a cost: misspelled arguments will be silently ignored. The ellipsis package provides a collection of functions to catch problems and alert the user.
Author(s)
Maintainer: Hadley Wickham hadley@rstudio.com
Other contributors:
RStudio [copyright holder]
See Also
Useful links:
Report bugs at https://github.com/r-lib/ellipsis/issues
Check that dots are unused
Description
Sometimes you just want to use ... to force your users to fully name
the details arguments. This function warns if ... is not empty.
Arguments
env |
Environment in which to look for |
action |
The action to take when the dots have not been used. One of
|
Examples
f <- function(x, ..., foofy = 8) {
check_dots_empty()
x + foofy
}
try(f(1, foof = 4))
f(1, foofy = 4)
Check that all dots are unnamed
Description
Named arguments in ... are often a sign of misspelled argument names.
Arguments
env |
Environment in which to look for |
action |
The action to take when the dots have not been used. One of
|
Examples
f <- function(..., foofy = 8) {
check_dots_unnamed()
c(...)
}
f(1, 2, 3, foofy = 4)
try(f(1, 2, 3, foof = 4))
Check that all dots have been used
Description
Automatically sets exit handler to run when function terminates, checking
that all elements of ... have been evaluated. If you use on.exit()
elsewhere in your function, make sure to use add = TRUE so that you
don't override the handler set up by check_dots_used().
Arguments
env |
Environment in which to look for |
action |
The action to take when the dots have not been used. One of
|
Examples
f <- function(...) {
check_dots_used()
g(...)
}
g <- function(x, y, ...) {
x + y
}
f(x = 1, y = 2)
try(f(x = 1, y = 2, z = 3))
try(f(x = 1, y = 2, 3, 4, 5))
Helper for consistent documentation of empty dots
Description
Use @inheritParams ellipsis::dots_empty in your package
to consistently document an unused ... argument.
Arguments
... |
These dots are for future extensions and must be empty. |
Helper for consistent documentation of used dots
Description
Use @inheritParams ellipsis::dots_used in your package
to consistently document an unused ... argument.
Arguments
... |
Arguments passed to methods. |
Safe version of median
Description
safe_median() works stats::median() but warns if some elements of ...
are never used.
Usage
safe_median(x, ...)
## S3 method for class 'numeric'
safe_median(x, ..., na.rm = TRUE)
Arguments
x |
Numeric vector |
... |
Additional arguments passed on to methods. |
na.rm |
For numeric method, should missing values be removed? |
Examples
x <- c(1:10, NA)
safe_median(x, na.rm = TRUE)
median(x, na.rm = TRUE)
try(median(x, na.mr = TRUE))
try(safe_median(x, na.mr = TRUE))
try(median(1, 2, 3))
try(safe_median(1, 2, 3))