Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How can I get the values of all arguments used when evaluating a call object in a specified environment

Tags:

r

nse

pryr

say I have a function f as

f = function(x = 1, y, z, t) { x + y + z}

and a list l such

l = list(Y = 2, t = "test")

I can evaluate f in l like

eval(quote(f(y = Y, z = 3)), envir = l)
6

My question is that I'd like to get all the values of the arguments that ends up being used by the function f ie. a function magic that would take a call object and an environment and would return the values of all the arguments that would be used in evaluating the expression.

For instance:

call_obj = quote(f(y = Y, z = 3))
magic(call_obj, envir = l)
# I get a named list which value is list(1,2,3,"test")
# For that matter I do not even need the default arguments values (x)

EDIT: Adding a bounty for a base-r answer (while @Artem Sokolov provided a purrr-rlang one, extracting a couple relevant functions would still be fine though)

like image 523
statquant Avatar asked Dec 30 '22 17:12

statquant


2 Answers

tidyverse solution

# Identify the variables in l that can be used to specify arguments of f
args1 <- l[ intersect( names(formals(f)), names(l) ) ]

# Augment the call with these variables
call_obj2 <- rlang::call_modify( call_obj, !!!args1 )
# f(y = Y, z = 3, t = "test")

# Evaluate the arguments of the call in the context of l and combine with defaults
purrr::list_modify( formals(f),
                   !!!purrr::map(rlang::call_args(call_obj2), eval, l) )

base R solution

# As above
args1 <- l[ intersect( names(formals(f)), names(l) ) ]

# Augment the call with variables in args1
l1 <- modifyList( as.list(call_obj), args1 )[-1]

# Evaluate the arguments in the context of l and combine with defaults
modifyList(formals(f), lapply(l1, eval, l))

Output for both solutions

# $x
# [1] 1
#
# $y
# [1] 2
#
# $z
# [1] 3
#
# $t
# [1] "test"
like image 57
Artem Sokolov Avatar answered Jan 02 '23 06:01

Artem Sokolov


How about this one:

magic <- function(call_obj, envir) {
  
  call_fun <- as.list(as.call(call_obj))[[1]]
  
  call_obj <- match.call(match.fun(call_fun), as.call(call_obj))

  
  ## arguments supplied in call
  call_args <- as.list(call_obj)[-1]
  
  
  ## arguments from function definition
  fun_args <- formals(match.fun(call_fun))
  
  ## match arguments from call with list
  new_vals_call <- lapply(call_args, function(x) eval(x, envir = envir))
  
  ## match arguments from function definition with list
  ## because everything (including NULL) can be a valid function argument we cannot directly use mget()
  
  in_list <- sapply(names(fun_args), function(x, env) exists(x, envir = env), as.environment(envir))
  new_vals_formals <- mget(names(fun_args), envir = as.environment(envir), ifnotfound = "")[in_list]
  
  
  ## values in the call take precedence over values from the list (can easily be reversed if needed)
  new_vals_complete <- modifyList(fun_args, new_vals_formals, keep.null = TRUE)
  new_vals_complete <- modifyList(new_vals_complete, new_vals_call, keep.null = TRUE)
  
  ## Construct a call object (if you want only the list of arguments return new_vals_complete)
  as.call(c(call_fun, new_vals_complete))
}


# -------------------------------------------------------------------------


f <- function(x = 1, y, z, t) { x + y + z}


## Tests

## basic test
magic(quote(f(y = Y, z = 3)), list(Y = 2, t = "test"))
#> f(x = 1, y = 2, z = 3, t = "test")    

## precedence (t defined twice)
magic(quote(f(y = Y, z = 3, t=99)), list(Y = 2, t = "test"))
#> f(x = 1, y = 2, z = 3, t = 99)

## missing values (z is missing)
magic(quote(f(y = Y)), list(Y = 2, t = "test"))
#> f(x = 1, y = 2, z = , t = "test")

## NULL values in call
magic(quote(f(y = Y, z = NULL)), list(Y = 2, t = "test"))
#> f(x = 1, y = 2, z = NULL, t = "test")

## NULL values in list
magic(quote(f(y = Y, z = 3)), list(Y = 2, t = NULL))
#> f(x = 1, y = 2, z = 3, t = NULL)

## NULL values and precendece
magic(quote(f(y = Y, z = 3, t= NULL)), list(Y = 2, t = "test"))
#> f(x = 1, y = 2, z = 3, t = NULL)
magic(quote(f(y = Y, z = 3, t=99)), list(Y = 2, t = NULL))
#> f(x = 1, y = 2, z = 3, t = 99)

## call with subcalls
magic(quote(f(y = sin(pi), z = 3)), list(Y = 2, t = "test"))
#> f(x = 1, y = 1.22460635382238e-16, z = 3, t = "test")
magic(quote(f(y = Y, z = 3)), list(Y = sin(pi), t = "test"))
#> f(x = 1, y = 1.22460635382238e-16, z = 3, t = "test")

## call with additional vars (g is not an argument of f)  -> error: unused arguments
magic(quote(f(g = Y, z = 3)), list(Y = 2, t = "test"))

## list with with additional vars (g is not an argument of f) -> vars are ignored 
magic(quote(f(y = Y, z = 3)), list(Y = 2, t = "test", g=99))
#> f(x = 1, y = 2, z = 3, t = "test")

## unnamed arguments
magic(quote(f(99, y = Y, z = 3)), list(Y = 2, t = "test"))
#> f(x = 99, y = 2, z = 3, t = "test")
magic(quote(f(99, y = Y, 77)), list(Y = 2, t = "test"))
#> f(x = 99, y = 2, z = 77, t = "test")
like image 31
AEF Avatar answered Jan 02 '23 08:01

AEF