installing.html

<!DOCTYPE html>

<html>

<head>

<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta http-equiv="X-UA-Compatible" content="IE=EDGE" />




<title>Installing RangeShiftR</title>

<script src="site_libs/header-attrs-2.29/header-attrs.js"></script>
<script src="site_libs/jquery-3.6.0/jquery-3.6.0.min.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="site_libs/bootstrap-3.3.5/css/bootstrap.min.css" rel="stylesheet" />
<script src="site_libs/bootstrap-3.3.5/js/bootstrap.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/html5shiv.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/respond.min.js"></script>
<style>h1 {font-size: 34px;}
       h1.title {font-size: 38px;}
       h2 {font-size: 30px;}
       h3 {font-size: 24px;}
       h4 {font-size: 18px;}
       h5 {font-size: 16px;}
       h6 {font-size: 12px;}
       code {color: inherit; background-color: rgba(0, 0, 0, 0.04);}
       pre:not([class]) { background-color: white }</style>
<script src="site_libs/navigation-1.1/tabsets.js"></script>
<link href="site_libs/highlightjs-9.12.0/textmate.css" rel="stylesheet" />
<script src="site_libs/highlightjs-9.12.0/highlight.js"></script>
<link href="site_libs/font-awesome-6.5.2/css/all.min.css" rel="stylesheet" />
<link href="site_libs/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet" />

<style type="text/css">
  code{white-space: pre-wrap;}
  span.smallcaps{font-variant: small-caps;}
  span.underline{text-decoration: underline;}
  div.column{display: inline-block; vertical-align: top; width: 50%;}
  div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
  ul.task-list{list-style: none;}
    </style>

<style type="text/css">code{white-space: pre;}</style>
<script type="text/javascript">
if (window.hljs) {
  hljs.configure({languages: []});
  hljs.initHighlightingOnLoad();
  if (document.readyState && document.readyState === "complete") {
    window.setTimeout(function() { hljs.initHighlighting(); }, 0);
  }
}
</script>









<style type = "text/css">
.main-container {
  max-width: 940px;
  margin-left: auto;
  margin-right: auto;
}
img {
  max-width:100%;
}
.tabbed-pane {
  padding-top: 12px;
}
.html-widget {
  margin-bottom: 20px;
}
button.code-folding-btn:focus {
  outline: none;
}
summary {
  display: list-item;
}
details > summary > p:only-child {
  display: inline;
}
pre code {
  padding: 0;
}
</style>


<style type="text/css">
.dropdown-submenu {
  position: relative;
}
.dropdown-submenu>.dropdown-menu {
  top: 0;
  left: 100%;
  margin-top: -6px;
  margin-left: -1px;
  border-radius: 0 6px 6px 6px;
}
.dropdown-submenu:hover>.dropdown-menu {
  display: block;
}
.dropdown-submenu>a:after {
  display: block;
  content: " ";
  float: right;
  width: 0;
  height: 0;
  border-color: transparent;
  border-style: solid;
  border-width: 5px 0 5px 5px;
  border-left-color: #cccccc;
  margin-top: 5px;
  margin-right: -10px;
}
.dropdown-submenu:hover>a:after {
  border-left-color: #adb5bd;
}
.dropdown-submenu.pull-left {
  float: none;
}
.dropdown-submenu.pull-left>.dropdown-menu {
  left: -100%;
  margin-left: 10px;
  border-radius: 6px 0 6px 6px;
}
</style>

<script type="text/javascript">
// manage active state of menu based on current page
$(document).ready(function () {
  // active menu anchor
  href = window.location.pathname
  href = href.substr(href.lastIndexOf('/') + 1)
  if (href === "")
    href = "index.html";
  var menuAnchor = $('a[href="' + href + '"]');

  // mark the anchor link active (and if it's in a dropdown, also mark that active)
  var dropdown = menuAnchor.closest('li.dropdown');
  if (window.bootstrap) { // Bootstrap 4+
    menuAnchor.addClass('active');
    dropdown.find('> .dropdown-toggle').addClass('active');
  } else { // Bootstrap 3
    menuAnchor.parent().addClass('active');
    dropdown.addClass('active');
  }

  // Navbar adjustments
  var navHeight = $(".navbar").first().height() + 15;
  var style = document.createElement('style');
  var pt = "padding-top: " + navHeight + "px; ";
  var mt = "margin-top: -" + navHeight + "px; ";
  var css = "";
  // offset scroll position for anchor links (for fixed navbar)
  for (var i = 1; i <= 6; i++) {
    css += ".section h" + i + "{ " + pt + mt + "}\n";
  }
  style.innerHTML = "body {" + pt + "padding-bottom: 40px; }\n" + css;
  document.head.appendChild(style);
});
</script>

<!-- tabsets -->

<style type="text/css">
.tabset-dropdown > .nav-tabs {
  display: inline-table;
  max-height: 500px;
  min-height: 44px;
  overflow-y: auto;
  border: 1px solid #ddd;
  border-radius: 4px;
}

.tabset-dropdown > .nav-tabs > li.active:before, .tabset-dropdown > .nav-tabs.nav-tabs-open:before {
  content: "\e259";
  font-family: 'Glyphicons Halflings';
  display: inline-block;
  padding: 10px;
  border-right: 1px solid #ddd;
}

.tabset-dropdown > .nav-tabs.nav-tabs-open > li.active:before {
  content: "\e258";
  font-family: 'Glyphicons Halflings';
  border: none;
}

.tabset-dropdown > .nav-tabs > li.active {
  display: block;
}

.tabset-dropdown > .nav-tabs > li > a,
.tabset-dropdown > .nav-tabs > li > a:focus,
.tabset-dropdown > .nav-tabs > li > a:hover {
  border: none;
  display: inline-block;
  border-radius: 4px;
  background-color: transparent;
}

.tabset-dropdown > .nav-tabs.nav-tabs-open > li {
  display: block;
  float: none;
}

.tabset-dropdown > .nav-tabs > li {
  display: none;
}
</style>

<!-- code folding -->




</head>

<body>


<div class="container-fluid main-container">




<div class="navbar navbar-default  navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-bs-toggle="collapse" data-target="#navbar" data-bs-target="#navbar">
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a class="navbar-brand" href="index.html">RangeShiftR tutorials</a>
    </div>
    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="index.html">About RangeShiftR</a>
</li>
<li>
  <a href="installing.html">Installing RangeShiftR</a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
    RangeShiftR tutorials
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
    <li>
      <a href="overview_0.html">0. General package introduction</a>
    </li>
    <li>
      <a href="tutorial_1.html">1. Range expansion</a>
    </li>
    <li>
      <a href="tutorial_2.html">2. Patch connectivity</a>
    </li>
    <li>
      <a href="tutorial_3.html">3. Dynamic landscapes &amp; SMS paths</a>
    </li>
  </ul>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
    Former versions
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
    <li>
      <a href="installing_v2.0.html">RangeShiftR v1.1.2 (based on RangeShifter 2.0)</a>
    </li>
    <li>
      <a href="overview_0_v2.0.html">0. General package introduction v1.1.2</a>
    </li>
    <li>
      <a href="tutorial_1_v2.0.html">1. Range expansion v1.1.2</a>
    </li>
    <li>
      <a href="tutorial_2_v2.0.html">2. Patch connectivity v1.1.2</a>
    </li>
    <li>
      <a href="tutorial_3_v2.0.html">3. Dynamic landscapes &amp; SMS paths v1.1.2</a>
    </li>
    <li>
      <a href="tutorial_4_v2.0.html">4. Evolution of dispersal v1.1.2</a>
    </li>
    <li>
      <a href="appendix_tutorial_3_v2.0.html">Appendix A3. Create dynamic landscapes v1.1.2</a>
    </li>
  </ul>
</li>
      </ul>
      <ul class="nav navbar-nav navbar-right">
        <li>
  <a href="mailto:RangeShiftR@uni-potsdam.de">
    <span class="fa fa-envelope"></span>
     
  </a>
</li>
<li>
  <a href="https://rangeshifter.github.io">
    <span class="fa fa-home"></span>
     
  </a>
</li>
<li>
  <a href="https://github.com/RangeShifter">
    <span class="fa fa-github"></span>
     
  </a>
</li>
<li>
  <a href="https://twitter.com/ZurellLab">
    <span class="fa fa-twitter"></span>
     
  </a>
</li>
      </ul>
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

<div id="header">



<h1 class="title toc-ignore">Installing RangeShiftR</h1>

</div>


<p>The <code>RangeShiftR</code> package source is publicly released on a
<a
href="https://github.com/RangeShifter/RangeShiftR-pkg"><em>github</em>
repository</a> as a beta version (it is not available on <em>CRAN</em>).
For further information please contact us under <a
href="mailto:RangeshiftR@uni-potsdam.de">RangeShiftR@uni-potsdam.de</a>.</p>
<div id="install-and-load-required-packages" class="section level1">
<h1>Install and load required packages</h1>
<p><code>RangeShiftR</code> has to be built from source by the user.
This requires the <code>R</code>-version <em>3.6.0</em> or higher as
well as a functional C++ toolchain (see below). All other dependencies
are handled automatically during installation.</p>
<p>Install <code>pak</code> if you don’t have them already.</p>
<pre class="r"><code>library(&quot;pak&quot;)</code></pre>
<pre><code>## Warning: package &#39;pak&#39; was built under R version 4.5.2</code></pre>
</div>
<div id="compiler-toolchain" class="section level1">
<h1>Compiler toolchain</h1>
<p>In order to build the package from source, C++ compiler toolchain is
required. The exact procedure depends on your operating system.</p>
<ul>
<li><p>on Windows: Install the <code>Rtools</code> package from <a
href="https://cran.r-project.org/bin/windows/Rtools/">CRAN</a>. Make
sure to install the version that matches your R version.</p></li>
<li><p>on Linux: Install the standard <code>R</code> development
packages (e.g. on Ubuntu and Debian:
<code>sudo apt-get install r-base-dev</code>).</p></li>
<li><p>on MacOS: Install the Apple Developer Tools
<code>xcode-select --install</code></p></li>
</ul>
</div>
<div id="install-the-rangeshiftr-package" class="section level1">
<h1>Install the RangeShiftR package</h1>
<p>Now, if all preparations are done and successful, we can install the
package directly from its public repository on <em>github</em>, using
<code>pak</code>:</p>
<pre class="r"><code>pak::pak(&quot;RangeShifter/RangeShiftR-pkg/RangeShiftR@main&quot;)</code></pre>
<p>After successful installation, which can take a few minutes, you can
load and use the package:</p>
<pre class="r"><code>library(RangeShiftR)</code></pre>
<pre><code>## RangeshiftR version 3.0.0 (22.04.2026)
## Copyright (C) 2020-2026 Anne-Kathleen Malchow, Greta Bocedi, Stephen C.F. Palmer, Justin M.J. Travis, Jette Wolff, Théo Pannetier, Roslyn Henry, Damaris Zurell
## 
## This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.
## You are welcome to redistribute it and/or modify it under certain conditions;
## type &#39;RangeShiftR_license()&#39; for details.</code></pre>
<div id="troubleshooting" class="section level4">
<h4>Troubleshooting</h4>
<p>If <code>pak</code>is not able to install RangeShiftR one reason
might be that <code>R</code> doesn’t find the C++ compiler due to an
inappropriately set path variable. In this variable your system stores
the paths in which to look for executables like the compiler
(e.g. <em>gcc</em> or <em>clang</em>), in the order in which they appear
in the path variable.</p>
<p>You can try and check if the path to the directory that contains your
compiler is part of the path variable.<br />
For example, on Windows 10: Go to Control panel -&gt; System and
Security -&gt; System -&gt; Advanced system settings -&gt; Environmental
variables.<br />
In the list of system variables, look for ‘Path’. If the correct path is
missing, you can add it manually:<br />
Click ‘edit’ on the ‘Path’ variable -&gt; add the correct variable (The
two standard paths would be ‘C:\Rtools\bin’ and
‘C:\Rtools\mingw_32\bin’; you can also try moving them up on the list so
they get searched first.)</p>
<p>For Linux you might need additional dependencies for required R
packages, e.g. <code>libcurl4-openssl-dev</code>,
<code>libssl-dev</code> or <code>libxml2-dev</code></p>
<p>If questions or problems remain, please let us know via the
<em>github</em> <a
href="https://github.com/RangeShifter/RangeshiftR-tutorials/discussions">Forum</a>.</p>
</div>
</div>

<!DOCTYPE html>
<html>

<br>
<hr />
<div id="footer">
<p>Anne-Kathleen Malchow, Greta Bocedi, Steve Palmer, Justin Travis & Damaris Zurell <a href="https://creativecommons.org/licenses/by-nc-nd/4.0/" >(CC BY-NC-ND 4.0)</a>.  </p>
</div>

</html>



</div>

<script>

// add bootstrap table styles to pandoc tables
function bootstrapStylePandocTables() {
  $('tr.odd').parent('tbody').parent('table').addClass('table table-condensed');
}
$(document).ready(function () {
  bootstrapStylePandocTables();
});


</script>

<!-- tabsets -->

<script>
$(document).ready(function () {
  window.buildTabsets("TOC");
});

$(document).ready(function () {
  $('.tabset-dropdown > .nav-tabs > li').click(function () {
    $(this).parent().toggleClass('nav-tabs-open');
  });
});
</script>

<!-- code folding -->


<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
  (function () {
    var script = document.createElement("script");
    script.type = "text/javascript";
    script.src  = "https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
    document.getElementsByTagName("head")[0].appendChild(script);
  })();
</script>

</body>
</html>