env_name: Label of an environment

In rlang: Functions for Base Types and Core R and 'Tidyverse' Features

Label of an environment

Description

Special environments like the global environment have their own names. env_name() returns:

• "global" for the global environment.

• "empty" for the empty environment.

• "base" for the base package environment (the last environment on the search path).

• "namespace:pkg" if env is the namespace of the package "pkg".

• The name attribute of env if it exists. This is how the package environments and the imports environments store their names. The name of package environments is typically "package:pkg".

• The empty string "" otherwise.

env_label() is exactly like env_name() but returns the memory address of anonymous environments as fallback.

Usage

env_name(env)

env_label(env)

Arguments

env	An environment.

Examples

# Some environments have specific names:
env_name(global_env())
env_name(ns_env("rlang"))

# Anonymous environments don't have names but are labelled by their
# address in memory:
env_name(env())
env_label(env())

rlang documentation built on June 22, 2024, 9:31 a.m.