install

uninstall

Install and uninstall support for <code class="file">.Renviron.d</code> and <code class="file">.Rprofile.d</code>
startup directories by appending / removing one line of code to the
<code class="file">~/.Rprofile</code> file.

Adds support for R startup configuration via '.Renviron.d' and '.Rprofile.d' directories in addition to '.Renviron' and '.Rprofile' files.  This makes it possible to keep private / secret environment variables separate from other environment variables.  It also makes it easier to share specific startup settings by simply copying a file to a directory.

Henrik Bengtsson

startup

Friendly R Startup Configuration

install function

<dl><dt>path</dt>
<dd>The path where to create / update the <code class="file">.Rprofile</code> file.</dd>
<dt>backup</dt>
<dd>If <code>TRUE</code>, a timestamped backup copy of the original file is
created before modifying / overwriting it, otherwise not. If the backup
fails, then an error is produced and the R startup file is unmodified.</dd>
<dt>overwrite</dt>
<dd>If the R startup file already exist, then <code>FALSE</code> (default)
appends the startup code to the end of the file. is overwritten. If <code>TRUE</code>,
any pre-existing R startup file is overwritten.</dd>
<dt>make_dirs</dt>
<dd>If <code>TRUE</code> (default), directories <code class="file">.Renviron.d/</code> and
<code class="file">.Rprofile.d/</code> are created in folder <code>path</code>, if missing.</dd>
<dt>quiet</dt>
<dd>If <code>FALSE</code> (default), detailed messages are generated,
otherwise not.</dd></dl>

Arguments

<ul>
<li><code>install()</code>: injects a <code>tryCatch(startup::startup(), ...)</code> call to
the <code class="file">.Rprofile</code> file, which is created if missing.</li>
<li><code>uninstall()</code>: Remove calls to <code>startup::startup()</code> and similar.</li>
</ul>

Functions

Install and uninstall support for .Renviron.d and .Rprofile.d startup
directories — install

<dl>

<dt>path</dt>
<dd>The path where to create / update the <code class="file">.Rprofile</code> file.</dd>


<dt>backup</dt>
<dd>If <code>TRUE</code>, a timestamped backup copy of the original file is
created before modifying / overwriting it, otherwise not. If the backup
fails, then an error is produced and the R startup file is unmodified.</dd>


<dt>overwrite</dt>
<dd>If the R startup file already exist, then <code>FALSE</code> (default)
appends the startup code to the end of the file. is overwritten. If <code>TRUE</code>,
any pre-existing R startup file is overwritten.</dd>


<dt>make_dirs</dt>
<dd>If <code>TRUE</code> (default), directories <code class="file">.Renviron.d/</code> and
<code class="file">.Rprofile.d/</code> are created in folder <code>path</code>, if missing.</dd>


<dt>quiet</dt>
<dd>If <code>FALSE</code> (default), detailed messages are generated,
otherwise not.</dd>

</dl>

install: Install and uninstall support for .Renviron.d and .Rprofile.d startup directories

Description

Usage

Value

Arguments

Functions