File: disable.Rd

package info (click to toggle)
r-cran-packrat 0.9.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,900 kB
  • sloc: sh: 51; makefile: 5
file content (31 lines) | stat: -rw-r--r-- 1,039 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/disable.R
\name{disable}
\alias{disable}
\title{Disable the use of Packrat in a Project}
\usage{
disable(project = NULL, restart = TRUE)
}
\arguments{
\item{project}{The directory in which packrat will be disabled (defaults to
the current working directory)}

\item{restart}{If \code{TRUE}, restart the R session after disabling packrat.}
}
\description{
Disable packrat within a project, reverting to the use of standard user
package libraries.
}
\note{
Disabling packrat for a project removes the packrat initialization code
from the .Rprofile file, resulting in the use of standard user package
libraries. Note that the \code{packrat} directory is not deleted, but remains
unused.

To re-enable the use of packrat for a project you can call the
\code{\link{init}} function.

The \code{restart} parameter will only result in a restart of R when the R
environment packrat is running within makes available a restart function via
\code{getOption("restart")}.
}