Convenience helper, intended primarily for interactive use, that parses
each file (local path or github.com URL with @branch notation) into a
named list.
setupFiles(
files,
paths,
envir = parent.frame(),
verbose = getOption("Require.verbose", 1L)
)A vector or list of files to parse. These can be remote github.com files.
a list with named elements, specifically, modulePath, projectPath,
packagePath and all others that are in SpaDES.core::setPaths()
(i.e., inputPath, outputPath, scratchPath, cachePath, rasterTmpDir).
Each of these has a sensible default, which will be overridden but any user
supplied values.
See setup.
The environment where setupProject is called from. Defaults to
parent.frame() which should be fine in most cases and user shouldn't need
to set this
Numeric or logical indicating how verbose should the function
be. If -1 or -2, then as little verbosity as possible. If 0 or FALSE,
then minimal outputs; if 1 or TRUE, more outputs; 2 even more. NOTE: in
Require function, when verbose >= 2, also returns details as if
returnDetails = TRUE (for backwards compatibility).
setupFiles a named list with each element that was parsed.
setupFiles is a convenience function intended for interactive use to verify the files being parsed.
This is similar to parse, but each element must be a named list or a named object, such as a function.
It uses the same specification for https://github.com
files as setupProject, i.e., using @ for branch.
setupProject() for the high-level wrapper, setup_family for an overview.