as_mapper: Convert an object into a mapper function

Description Usage Arguments Examples

View source: R/as_mapper.R

Description

as_mapper is the powerhouse behind the varied function specifications that most purrr functions allow. It is an S3 generic. The default method forwards its arguments to rlang::as_function().

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
as_mapper(.f, ...)

## S3 method for class 'character'
as_mapper(.f, ..., .null, .default = NULL)

## S3 method for class 'numeric'
as_mapper(.f, ..., .null, .default = NULL)

## S3 method for class 'list'
as_mapper(.f, ..., .null, .default = NULL)

Arguments

.f

A function, formula, or vector (not necessarily atomic).

If a function, it is used as is.

If a formula, e.g. ~ .x + 2, it is converted to a function. There are three ways to refer to the arguments:

  • For a single argument function, use .

  • For a two argument function, use .x and .y

  • For more arguments, use ..1, ..2, ..3 etc

This syntax allows you to create very compact anonymous functions.

If character vector, numeric vector, or list, it is converted to an extractor function. Character vectors index by name and numeric vectors index by position; use a list to index by position and name at different levels. If a component is not present, the value of .default will be returned.

...

Additional arguments passed on to methods.

.default, .null

Optional additional argument for extractor functions (i.e. when .f is character, integer, or list). Returned when value is absent (does not exist) or empty (has length 0). .null is deprecated; please use .default instead.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
as_mapper(~ . + 1)
as_mapper(1)

as_mapper(c("a", "b", "c"))
# Equivalent to function(x) x[["a"]][["b"]][["c"]]

as_mapper(list(1, "a", 2))
# Equivalent to function(x) x[[1]][["a"]][[2]]

as_mapper(list(1, attr_getter("a")))
# Equivalent to function(x) attr(x[[1]], "a")

as_mapper(c("a", "b", "c"), .default = NA)

Example output

<lambda>
function (..., .x = ..1, .y = ..2, . = ..1) 
. + 1
attr(,"class")
[1] "rlang_lambda_function"
function (x, ...) 
pluck(x, 1, .default = NULL)
<environment: 0x1750480>
function (x, ...) 
pluck(x, "a", "b", "c", .default = NULL)
<environment: 0x175b670>
function (x, ...) 
pluck(x, 1, "a", 2, .default = NULL)
<environment: 0x1761d00>
function (x, ...) 
pluck(x, 1, function (x) 
attr(x, attr, exact = TRUE), .default = NULL)
<environment: 0x1ea17b0>
function (x, ...) 
pluck(x, "a", "b", "c", .default = NA)
<environment: 0x1ea6ad0>

purrr documentation built on April 19, 2020, 4:17 p.m.