Get an object in an environment

Source: R/env-binding.R

env_get() extracts an object from an enviroment env. By default, it does not look in the parent environments. env_get_list() extracts multiple objects from an environment into a named list.

env_get(env = caller_env(), nm, default, inherit = FALSE)

env_get_list(env = caller_env(), nms, default, inherit = FALSE)

Arguments

env

An environment.
nm, nms

Names of bindings. nm must be a single string.
default

A default value in case there is no binding for nm in env.
inherit

Whether to look for bindings in the parent environments.

Value

An object if it exists. Otherwise, throws an error.

Examples

parent <- child_env(NULL, foo = "foo")
env <- child_env(parent, bar = "bar")

# This throws an error because `foo` is not directly defined in env:
# env_get(env, "foo")

# However `foo` can be fetched in the parent environment:
env_get(env, "foo", inherit = TRUE)
#> [1] "foo"

# You can also avoid an error by supplying a default value:
env_get(env, "foo", default = "FOO")
#> [1] "FOO"