load_all loads a package. It roughly simulates what happens
when a package is installed and loaded with library().
load_all(
path = ".",
reset = TRUE,
recompile = FALSE,
export_all = TRUE,
helpers = TRUE,
quiet = FALSE,
...
)Path to a package, or within a package.
clear package environment and reset file cache before loading
any pieces of the package. This largely equivalent to running
unload(), however the old namespaces are not completely removed and no
.onUnload() hooks are called. Use reset = FALSE may be faster for
large code bases, but is a significantly less accurate approximation.
DEPRECATED. force a recompile of DLL from source code, if
present. This is equivalent to running pkgbuild::clean_dll() before
load_all
If TRUE (the default), export all objects.
If FALSE, export only the objects that are listed as exports
in the NAMESPACE file.
if TRUE loads testthat test helpers.
if TRUE suppresses output from this function.
Additional arguments passed to pkgload::load_all().
load_all() tries its best to reproduce the behaviour of
loadNamespace() and library(). However it deviates from normal
package loading in several ways.
It doesn't install the package on disk, so system.file() has no
way of determining the location of the development files. To work
around this, pkgload installs its own version of system.file()
on the search path to make it easier to use interactively while
developing. However this definition is only visible to the global
environment, not to the namespaces of third party packages.
One workaround for other packages to see the development files of
your package while you're developing with devtools is for them to
use fs::path_package() instead of system.file().
Whereas loadNamespace() and library() only load package
dependencies when they are needed, load_all() loads all packages
referenced in Imports at load time.
The namespace environment <namespace:pkgname>, is a child of
the imports environment, which has the name attribute
imports:pkgname. It is in turn is a child of
<namespace:base>, which is a child of the global environment.
(There is also a copy of the base namespace that is a child of the empty
environment.)
The package environment <package:pkgname> is an ancestor of the
global environment. Normally when loading a package, the objects
listed as exports in the NAMESPACE file are copied from the namespace
to the package environment. However, load_all by default will
copy all objects (not just the ones listed as exports) to the package
environment. This is useful during development because it makes all
objects easy to access.
To export only the objects listed as exports, use
export_all=FALSE. This more closely simulates behavior when
loading an installed package with library(), and can be
useful for checking for missing exports.
load_all also inserts shim functions into the imports environment
of the loaded package. It presently adds a replacement version of
system.file which returns different paths from
base::system.file. This is needed because installed and uninstalled
package sources have different directory structures. Note that this is not
a perfect replacement for base::system.file.
Currently load_all:
Loads all data files in data/. See load_data() for more
details.
Sources all R files in the R directory, storing results in
environment that behaves like a regular package namespace. See
below and load_code() for more details.
Compiles any C, C++, or Fortran code in the src/ directory and
connects the generated DLL into R. See pkgbuild::compile_dll()
for more details.
Loads any compiled translations in inst/po.
Runs .onAttach(), .onLoad() and .onUnload() functions at
the correct times.
If you use testthat, will load all test helpers so you can
access them interactively. devtools sets the DEVTOOLS_LOAD
environment variable to "true" to let you check whether the
helpers are run during package loading.
is_loading() returns TRUE when it is called while load_all()
is running. This may be useful e.g. in onLoad hooks.
if (FALSE) {
# Load the package in the current directory
load_all("./")
# Running again loads changed files
load_all("./")
# With reset=TRUE, unload and reload the package for a clean start
load_all("./", TRUE)
# With export_all=FALSE, only objects listed as exports in NAMESPACE
# are exported
load_all("./", export_all = FALSE)
}
Run the code above in your browser using DataLab