Is it possible to add help
to functions defined (with assign
) inside an R session?
Let's say I define a set of functions like so:
make_addn <- function(n) {
function(x) x + n
}
assign_addn <- function(n, env) {
name <- paste0("add", n)
fn <- make_addn(n)
assign(name, fn, envir = env)
}
purrr::walk(2:5, assign_addn, env = environment())
add2(3)
#> [1] 5
add5(5)
#> [1] 10
help(add3)
#> No documentation for 'add3' in specified packages and libraries:
#> you could try '??add3'
What I want to add is something like:
assign_addn <- function(n, env) {
name <- paste0("add", n)
fn <- make_addn(n)
help_text <- glue::glue("Add {n} to a number")
# make help text??
assign(name, fn, envir = env)
}
# ...
help(add3)
#> Add 3 to a number
Does this make sense? Is this possible? Or even desirable?