File: pkg_env.Rd

package info (click to toggle)
r-cran-pkgload 1.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,164 kB
  • sloc: sh: 13; cpp: 9; ansic: 8; makefile: 2
file content (33 lines) | stat: -rw-r--r-- 1,103 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/package-env.R
\name{pkg_env}
\alias{pkg_env}
\title{Return package environment}
\usage{
pkg_env(package)
}
\arguments{
\item{package}{package name.}
}
\description{
This is an environment like \verb{<package:pkg>}. The package
environment contains the exported objects from a package. It is
attached, so it is an ancestor of \code{R_GlobalEnv}.
}
\details{
When a package is loaded the normal way, using \code{\link[=library]{library()}},
this environment contains only the exported objects from the
namespace. However, when loaded with \code{\link[=load_all]{load_all()}}, this
environment will contain all the objects from the namespace, unless
\code{load_all} is used with \code{export_all=FALSE}.

If the package is not attached, this function returns \code{NULL}.
}
\seealso{
\code{\link[=ns_env]{ns_env()}} for the namespace environment that
all the objects (exported and not exported).

\code{\link[=imports_env]{imports_env()}} for the environment that contains
imported objects for the package.
}
\keyword{internal}