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
46
47
48
49
50
51
52
53
54
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/paths.R
\name{packrat-resources}
\alias{packrat-resources}
\alias{project_dir}
\alias{src_dir}
\alias{lib_dir}
\alias{bundles_dir}
\title{Paths to Packrat Resources}
\usage{
project_dir(project = NULL)
src_dir(project = NULL)
lib_dir(project = NULL)
bundles_dir(project = NULL)
}
\arguments{
\item{project}{The project directory.}
}
\description{
These functions provide a mechanism for retrieving the paths to
Packrat resource directories. Each of these directories can be
overridden by setting either an environment variable, or an \R
option.
}
\section{Project Directory}{
\code{project_dir()} is special -- the \code{R_PACKRAT_PROJECT_DIR}
environment variable is set and unset by \code{\link{on}} and
\code{\link{off}}, respectively, and generally should not be
overridden by the user.
}
\section{Directory Resolution}{
The following table shows the order in which resource directories
are discovered (from left to right). The first non-empty result is
used.
\tabular{llll}{
\strong{API} \tab \strong{Environment Variable} \tab \strong{R Option} \tab \strong{Default Value} \cr
\code{project_dir()} \tab \code{R_PACKRAT_PROJECT_DIR} \tab \code{packrat.project.dir} \tab \code{getwd()} \cr
\code{src_dir()} \tab \code{R_PACKRAT_SRC_DIR} \tab \code{packrat.src.dir} \tab \code{"packrat/src"} \cr
\code{lib_dir()} \tab \code{R_PACKRAT_LIB_DIR} \tab \code{packrat.lib.dir} \tab \code{"packrat/lib"} \cr
\code{bundles_dir()} \tab \code{R_PACKRAT_BUNDLES_DIR} \tab \code{packrat.bundles.dir} \tab \code{"packrat/bundles"} \cr
\emph{(none)} \tab \code{R_PACKRAT_LIB_R_DIR} \tab \code{packrat.lib-r.dir} \tab \code{"packrat/lib-R"} \cr
\emph{(none)} \tab \code{R_PACKRAT_LIB_EXT_DIR} \tab \code{packrat.lib-ext.dir} \tab \code{"packrat/lib-ext"} \cr
}
}
|
