as_environment

0th

Percentile

Coerce to an environment

as_environment() coerces named vectors (including lists) to an environment. It first checks that x is a dictionary (see is_dictionaryish()). If supplied an unnamed string, it returns the corresponding package environment (see pkg_env()).

Usage
as_environment(x, parent = NULL)
Arguments
x

An object to coerce.

parent

A parent environment, empty_env() by default. This argument is only used when x is data actually coerced to an environment (as opposed to data representing an environment, like NULL representing the empty environment).

Details

If x is an environment and parent is not NULL, the environment is duplicated before being set a new parent. The return value is therefore a different environment than x.

Life cycle

as_env() was soft-deprecated and renamed to as_environment() in rlang 0.2.0. This is for consistency as type predicates should not be abbreviated.

Aliases
  • as_environment
Examples
# NOT RUN {
# Coerce a named vector to an environment:
env <- as_environment(mtcars)

# By default it gets the empty environment as parent:
identical(env_parent(env), empty_env())


# With strings it is a handy shortcut for pkg_env():
as_environment("base")
as_environment("rlang")

# With NULL it returns the empty environment:
as_environment(NULL)
# }
Documentation reproduced from package rlang, version 0.2.2, License: GPL-3

Community examples

Looks like there are no examples yet.