ns-topenv: Top Level Environment

Description Usage Arguments Details See Also Examples

Description

Finding the top level environment from an environment envir and its enclosing environments.

Usage

1
2
topenv(envir = parent.frame(),
       matchThisEnv = getOption("topLevelEnvironment"))

Arguments

envir

environment.

matchThisEnv

return this environment, if it matches before any other criterion is satisfied. The default, the option topLevelEnvironment, is set by sys.source, which treats a specific environment as the top level environment. Supplying the argument as NULL means it will never match.

Details

topenv returns the first top level environment found when searching envir and its enclosing environments. An environment is considered top level if it is the internal environment of a namespace, a package environment in the search path, or .GlobalEnv .

See Also

environment, notably parent.env() on “enclosing environments”; loadNamespace for more on namespaces.

Examples

1
2
3
4
topenv(.GlobalEnv)
topenv(new.env()) # also global env
topenv(environment(ls))# namespace:base
topenv(environment(lm))# namespace:stats

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.