Run an R script, in the context of a project using renv. The script will
be run within an R sub-process.

A dependency management toolkit for R. Using 'renv', you can create
and manage project-local R libraries, save the state of these libraries to
a 'lockfile', and later restore your library as required. Together, these
tools can help make your projects more isolated, portable, and reproducible.

Kevin Ushey

renv

Project Environments

Hadley Wickham

Posit Software, PBC 

run function

<dl><dt>script</dt>
<dd>The path to an R script.</dd>
<dt>...</dt>
<dd>Unused arguments, reserved for future expansion. If any arguments
are matched to <code>...</code>, renv will signal an error.</dd>
<dt>job</dt>
<dd>Run the requested script as an RStudio job? Requires a recent
version of both RStudio and the rstudioapi packages. When <code>NULL</code>, the
script will be run as a job if possible, and as a regular R process
launched by <code><a href="/link/system2()?package=renv&version=1.0.11" data-mini-rdoc="renv::system2()">system2()</a></code> if not.</dd>
<dt>name</dt>
<dd>The name to associate with the job, for scripts run as a job.</dd>
<dt>project</dt>
<dd>The path to the renv project. This project will be loaded
before the requested script is executed. When <code>NULL</code> (the default), renv
will automatically determine the project root for the associated script
if possible.</dd></dl>

Arguments

Run a script — run

<dl>

<dt>script</dt>
<dd>The path to an R script.</dd>


<dt>...</dt>
<dd>Unused arguments, reserved for future expansion. If any arguments
are matched to <code>...</code>, renv will signal an error.</dd>


<dt>job</dt>
<dd>Run the requested script as an RStudio job? Requires a recent
version of both RStudio and the rstudioapi packages. When <code>NULL</code>, the
script will be run as a job if possible, and as a regular R process
launched by <code><a href='https://rdrr.io/r/base/system2.html'>system2()</a></code> if not.</dd>


<dt>name</dt>
<dd>The name to associate with the job, for scripts run as a job.</dd>


<dt>project</dt>
<dd>The path to the renv project. This project will be loaded
before the requested script is executed. When <code>NULL</code> (the default), renv
will automatically determine the project root for the associated script
if possible.</dd>

</dl>

run: Run a script

Description

Usage

Value

Arguments