ruler (version 0.2.3)

rules: Create a list of rules

Description

rules() is a function designed to create input for .funs argument of scoped dplyr "mutating" verbs (such as summarise_all() and transmute_all()). For version of dplyr less than 0.8.0 it is a direct wrapper for funs() which does custom name repair (see 'Details'). For newer versions it converts bare expressions with . as input into formulas and repairs names of the output.

Usage

rules(..., .args = list(), .prefix = "._.")

Arguments

...

Element(s) suitable as .funs argument (in scoped "mutating" verbs) for current version of dplyr. It can also be a bare expression with . as input even if dplyr version is 0.8.0 or newer.

.args

A named list of additional arguments to be added to all function calls (as in dplyr::funs()). Note that this argument isn't used if installed version of dplyr is 0.8.0 or newer. Use other methods to supply arguments: ... argument in scoped verbs or make own explicit functions.

.prefix

Prefix to be added to function names.

Details

rules() repairs names by the following algorithm:

• Absent names are replaced with the 'rule__\ind\' where \ind\ is the index of function position in the ... .

• .prefix is added at the beginning of all names. The default is ._. . It is picked for its symbolism (it is the Morse code of letter 'R') and rare occurrence in names. In those rare cases it can be manually changed but this will not be tracked further. Note that it is a good idea for .prefix to be syntactic, as newer versions of dplyr (>= 0.8.0) will force tibble names to be syntactic. To check if string is "good", use it as input to make.names(): if output equals that string than it is a "good" choice.

Examples

# NOT RUN {
if (utils::packageVersion("dplyr") < "0.8.0") {
  rules_1 <- rules(mean, sd, .args = list(na.rm = TRUE))
  rules_1_ref <- dplyr::funs('._.rule__1' = mean, '._.rule__2' = sd,
                             .args = list(na.rm = TRUE))
  identical(rules_1, rules_1_ref)

  rules_2 <- rules(mean, sd = sd, "var")
  rules_2_ref <- dplyr::funs(
    '._.rule__1' = mean,
    '._.sd' = sd,
    '._.rule__3' = "var"
  )
  identical(rules_2, rules_2_ref)

  rules_3 <- rules(mean, .prefix = "a_a_")
  rules_3_ref <- dplyr::funs('a_a_rule__1' = mean)
  identical(rules_3, rules_3_ref)
}

if (utils::packageVersion("dplyr") >= "0.8.0") {
  # `rules()` also accepts bare expression calls with `.` as input, which is
  # not possible with advised `list()` approach of `dplyr`
  dplyr::summarise_all(mtcars[, 1:2], rules(sd, "sd", sd(.), ~ sd(.)))

  dplyr::summarise_all(mtcars[, 1:2], rules(sd, .prefix = "a_a_"))

  # Use `...` in `summarise_all()` to supply extra arguments
  dplyr::summarise_all(data.frame(x = c(1:2, NA)), rules(sd), na.rm = TRUE)
}

# }