-
Notifications
You must be signed in to change notification settings - Fork 153
/
Copy pathmodify.Rd
38 lines (35 loc) · 1008 Bytes
/
modify.Rd
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/modify.R
\name{modify}
\alias{modify}
\title{Modify a Lockfile}
\usage{
modify(project = NULL, changes = NULL)
}
\arguments{
\item{project}{The project directory. If \code{NULL}, then the active project will
be used. If no project is currently active, then the current working
directory is used instead.}
\item{changes}{A list of changes to be merged into the lockfile.
When \code{NULL} (the default), the lockfile is instead opened for
interactive editing.}
}
\value{
The project directory, invisibly. Note that this function is normally
called for its side effects.
}
\description{
Modify a project's lockfile, either interactively or non-interactively.
}
\details{
After edit, if the lockfile edited is associated with the active project, any
state-related changes (e.g. to \R repositories) will be updated in the
current session.
}
\examples{
\dontrun{
# modify an existing lockfile
if (interactive())
renv::modify()
}
}