<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="Loads additional packages as part of the fastverse. By default only for the session, but extensions can be saved up to reinstallation/updating of the fastverse package."><title>Extend the fastverse — fastverse_extend • fastverse</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Extend the fastverse — fastverse_extend"><meta property="og:description" content="Loads additional packages as part of the fastverse. By default only for the session, but extensions can be saved up to reinstallation/updating of the fastverse package."><meta property="og:image" content="/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
    

    <nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
    
    <a class="navbar-brand me-2" href="../index.html">fastverse</a>

    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">0.3.2</small>

    
    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item">
  <a class="nav-link" href="../reference/index.html">Reference</a>
</li>
<li class="nav-item">
  <a class="nav-link" href="../articles/index.html">Articles</a>
</li>
<li class="nav-item">
  <a class="nav-link" href="../news/index.html">News</a>
</li>
      </ul><form class="form-inline my-2 my-lg-0" role="search">
        <input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>

      <ul class="navbar-nav"><li class="nav-item">
  <a class="external-link nav-link" href="https://github.com/fastverse/fastverse/" aria-label="github">
    <span class="fab fa fab fa-github fa-lg"></span>
     
  </a>
</li>
      </ul></div>

    
  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.png" class="logo" alt=""><h1>Extend the fastverse</h1>
      <small class="dont-index">Source: <a href="https://github.com/fastverse/fastverse/blob/HEAD/R/attach.R" class="external-link"><code>R/attach.R</code></a></small>
      <div class="d-none name"><code>fastverse_extend.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Loads additional packages as part of the <em>fastverse</em>. By default only for the session, but extensions can be saved up to reinstallation/updating of the <em>fastverse</em> package.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">fastverse_extend</span><span class="op">(</span></span>
<span>  <span class="va">...</span>,</span>
<span>  install <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  permanent <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  check.conflicts <span class="op">=</span> <span class="op">!</span><span class="fu"><a href="https://rdrr.io/r/base/Logic.html" class="external-link">isTRUE</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"fastverse.quiet"</span><span class="op">)</span><span class="op">)</span>,</span>
<span>  topics <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  repos <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"repos"</span><span class="op">)</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
    <dl><dt>...</dt>
<dd><p>comma-separated package names, quoted or unquoted, or vectors of package names.</p></dd>


<dt>install</dt>
<dd><p>logical. Install packages not available?</p></dd>


<dt>permanent</dt>
<dd><p>logical. Should packages be saved and included when <code><a href="https://fastverse.github.io/fastverse/" class="external-link">library(fastverse)</a></code> is called next time? Implemented via a config file saved to the package directory. The file will be removed if the <em>fastverse</em> is reinstalled, and can be removed without reinstallation using <code><a href="fastverse_reset.html">fastverse_reset</a></code>. Packages can be removed from the config file using <code><a href="fastverse_detach.html">fastverse_detach(..., permanent = TRUE)</a></code>.</p></dd>


<dt>check.conflicts</dt>
<dd><p>logical. Should conflicts between extension packages and attached packages be checked?</p></dd>


<dt>topics</dt>
<dd><p>depreciated argument used to bulk-attach or install suggested extension packages prior to v0.3.0.</p></dd>


<dt>repos</dt>
<dd><p>character vector. Base URL(s) of the repositories to use, e.g., the URL of a CRAN mirror such as <code>"https://cloud.r-project.org"</code>. 
The macro <code>.fastverse_repos</code> contains the URL of the <a href="https://fastverse.r-universe.dev" class="external-link">fastverse r-universe server</a> to check/install the development version of packages.</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    

<p><code>fastverse_extend</code> returns <code>NULL</code> invisibly.</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>The <em>fastverse</em> can be extended using a free choice of packages. An overview of high-performing packages for various tasks is provided in the <a href="https://github.com/fastverse/fastverse#suggested-extensions" class="external-link">README</a> file.  <!-- %, packages listed under \code{topics}, or a combination of both. If \code{install = FALSE}, only packages  -->
<!-- % among the \code{topics} groups that are available are considered, others are disregarded.  --></p>
<p>When the <em>fastverse</em> is extended calling <code>fastverse_extend(...)</code>, the packages that are not attached are attached, but conflicts are checked for all specified packages. 
If <code>permanent = FALSE</code>, an <code>options("fastverse.extend")</code> is set which stores these extension packages, regardless of whether they were already attached or not. When calling 
<code><a href="fastverse_packages.html">fastverse_packages</a></code>, <code><a href="fastverse_deps.html">fastverse_deps</a></code>, <code><a href="fastverse_conflicts.html">fastverse_conflicts</a></code>, <code><a href="fastverse_update.html">fastverse_update</a></code>, <code><a href="fastverse_sitrep.html">fastverse_sitrep</a></code> or <code><a href="fastverse_detach.html">fastverse_detach</a></code>, these packages are included as part of the <em>fastverse</em>. 
This is also the case if <code>permanent = TRUE</code>, with the only difference that instead of populating the option, a file is saved to the package directory such that the packages are also loaded
(as part of the core <em>fastverse</em>) when calling <code><a href="https://fastverse.github.io/fastverse/" class="external-link">library(fastverse)</a></code> in the next session. To extend the <em>fastverse</em> for the current session when it is not yet loaded, users can also set <code>options(fastverse.extend = c(...))</code>, where <code>c(...)</code>
is a character vector of package names, before calling <code><a href="https://fastverse.github.io/fastverse/" class="external-link">library(fastverse)</a></code>.</p>
    </div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p><code><a href="fastverse_detach.html">fastverse_detach</a></code>, <code><a href="fastverse-package.html">fastverse</a></code></p></div>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># \donttest{</span></span></span>
<span class="r-in"><span><span class="va">ex</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"fastverse.extend"</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">fastverse_extend</span><span class="op">(</span><span class="va">xts</span>, <span class="va">stringi</span>, <span class="va">fasttime</span><span class="op">)</span></span></span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> -- <span style="font-weight: bold;">Attaching extension packages</span> ----------------------------- <span style="color: #0087FF;">fastverse</span> 0.3.2 --</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #0087FF;">v</span> <span style="color: #FF0087;">xts     </span> 0.13.1     <span style="color: #0087FF;">v</span> <span style="color: #FF0087;">fasttime</span> 1.1.0 </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #0087FF;">v</span> <span style="color: #FF0087;">stringi </span> 1.7.12     </span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> -- <span style="font-weight: bold;">Conflicts</span> ------------------------------------------ fastverse_conflicts() --</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #BB0000;">x</span> <span style="color: #0000BB;">xts</span>::<span style="color: #00BB00;">first()</span> masks <span style="color: #0000BB;">data.table</span>::first()</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #BB0000;">x</span> <span style="color: #0000BB;">xts</span>::<span style="color: #00BB00;">last()</span>  masks <span style="color: #0000BB;">data.table</span>::last()</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Undoing this again</span></span></span>
<span class="r-in"><span><span class="fu"><a href="fastverse_detach.html">fastverse_detach</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/sets.html" class="external-link">setdiff</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"fastverse.extend"</span><span class="op">)</span>, <span class="va">ex</span><span class="op">)</span>, session <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/rm.html" class="external-link">rm</a></span><span class="op">(</span><span class="va">ex</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="co"># }</span></span></span>
</code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p></p><p>Developed by Sebastian Krantz.</p>
</div>

<div class="pkgdown-footer-right">
  <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>

    </footer></div>

  

  

  </body></html>

