ns-topenv.Rd 1.1 KB
 Radford Neal committed May 18, 2013 1 2 % File src/library/base/man/ns-topenv.Rd % Part of the R package, http://www.R-project.org  Radford Neal committed Aug 26, 2016 3 % Copyright 1995-2011 R Core Team  Radford Neal committed May 18, 2013 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 % Distributed under GPL 2 or later \name{ns-topenv} \title{Top Level Environment} \alias{topenv} \description{ Finding the top level environment. } \usage{ topenv(envir = parent.frame(), matchThisEnv = getOption("topLevelEnvironment")) } \arguments{ \item{envir}{environment.} \item{matchThisEnv}{return this environment, if it matches before any other criterion is satisfied. The default, the option \samp{topLevelEnvironment}, is set by \code{\link{sys.source}}, which treats a specific environment as the top level environment. Supplying the argument as \code{NULL} means it will never match.} } \details{ \code{topenv} returns the first top level environment found when  Radford Neal committed May 18, 2013 27  searching \code{envir} and its enclosing environments. An environment is  Radford Neal committed May 18, 2013 28  considered top level if it is the internal environment of a namespace,  Radford Neal committed May 18, 2013 29 30 31 32 33 34 35  a package environment in the search path, or \code{.GlobalEnv}. } \examples{ topenv(.GlobalEnv) topenv(new.env()) } \keyword{programming}