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
34
35
36
37
38
39
40
41
42
43
44
45
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/configureBasiliskEnv.R
\name{configureBasiliskEnv}
\alias{configureBasiliskEnv}
\title{Configure client environments}
\usage{
configureBasiliskEnv(src = "R/basilisk.R")
}
\arguments{
\item{src}{String containing path to a R source file that defines one or more \linkS4class{BasiliskEnvironment} objects.}
}
\value{
One or more \pkg{basilisk} environments are created
corresponding to the \linkS4class{BasiliskEnvironment} objects in \code{src}.
A \code{NULL} is invisibly returned.
}
\description{
Configure the \pkg{basilisk} environments in the \code{configure} file of client packages.
}
\details{
This function is designed to be called in the \code{configure} file of client packages,
triggering the construction of \pkg{basilisk} environments during package installation.
It will only run if the \code{BASILISK_USE_SYSTEM_DIR} environment variable is set to \code{"1"}.
We take a source file as input to avoid duplicated definitions of the \linkS4class{BasiliskEnvironment}s.
These objects are used in \code{\link{basiliskStart}} in the body of the package, so they naturally belong in \code{R/};
we then ask \code{configure} to pull out that file (named \code{"basilisk.R"} by convention)
to create these objects during installation.
The source file in \code{src} should be executable on its own,
i.e., you can \code{\link{source}} it without loading any other packages (beside \pkg{basilisk}, obviously).
Non-\linkS4class{BasiliskEnvironment} objects can be created but are simply ignored in this function.
}
\examples{
\dontrun{
configureBasiliskEnv()
}
}
\seealso{
\code{\link{setupBasiliskEnv}}, which does the heavy lifting of setting up the environments.
}
\author{
Aaron Lun
}
|
