update README

eLTER-RI · Apr 26, 2024 · 9ecfe1e · 9ecfe1e
1 parent f659592
commit 9ecfe1e
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 21 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -38,8 +38,10 @@ knitr::opts_chunk$set(
 ## Installation and usage
 
 ### Installation from GitHub
-This **R** package ist available from GitHub only. Use {remotes} or {pacman}
-to install from GitHub:
+This **R** package ist available from GitHub only. Use
+    [{remotes}](https://cran.r-project.org/web/packages/remotes/index.html) or
+    [{pacman}](https://cran.r-project.org/web/packages/pacman/index.html)
+    to install from the GitHub source:
 
 ```
   ## install {remotes} if necessary:
@@ -48,6 +50,12 @@ to install from GitHub:
   remotes::install_github("eLTER-RI/validiraptor")
 ```
 
+> On Windows, you need to download and install
+    [Rtools](https://cran.r-project.org/bin/windows/Rtools/rtools43/rtools.html)
+    to compile the source files retrieved from GitHub. Make sure to install the
+    Rtools compatible with your R version (e. g. `RTools4.3` for R version 4.3).
+
+
 ## Notes for contributors
 
 ### Dependencies
@@ -81,10 +89,10 @@ guidelines when writing code for this project:
         except in function arguments.
     -   Always assign `<-`, not `=`
 
-#### Approach
--   Those coming from an object oriented language (like Python), please
-    observe R's [functional approach](https://adv-r.hadley.nz/fp.html)
-    together with the native pipe operator `|>` to prevent scope mess.
+#### Paradigm
+-   Please stick to R's [functional approach](https://adv-r.hadley.nz/fp.html)
+    and make liberal use of the native pipe operator `|>` to prevent scope mess
+and increase readability.
 
 
 <!-- general advice for contributors, include in README ?
@@ -155,9 +163,6 @@ end general dev advice  -->
 
 ## Authors
 
-List of contributors to the project. Include [ORCID](https://orcid.org/)
-to uniquely identify contributors and the Research Organization Registry
-([ROR](https://ror.org/)) for the institution.
 
 | Author | Affiliation | ORCID | e-mail |
 | :---: | :---: | :---: | :---: |

diff --git a/README.html b/README.html
@@ -657,11 +657,19 @@ <h2 id="table-of-contents">Table of Contents</h2>
 <h2 id="installation-and-usage">Installation and usage</h2>
 <h3 id="installation-from-github">Installation from GitHub</h3>
 <p>This <strong>R</strong> package ist available from GitHub only. Use
-{remotes} or {pacman} to install from GitHub:</p>
+<a href="https://cran.r-project.org/web/packages/remotes/index.html">{remotes}</a>
+or <a href="https://cran.r-project.org/web/packages/pacman/index.html">{pacman}</a>
+to install from the GitHub source:</p>
 <pre><code>  ## install {remotes} if necessary:
   if(!require(&quot;remotes&quot;)) install.packages(&quot;remotes&quot;)
   ## fetch and install {validiraptor}:
   remotes::install_github(&quot;eLTER-RI/validiraptor&quot;)</code></pre>
+<blockquote>
+<p>On Windows, you need to download and install <a href="https://cran.r-project.org/bin/windows/Rtools/rtools43/rtools.html">Rtools</a>
+to compile the source files retrieved from GitHub. Make sure to install
+the Rtools compatible with your R version (e. g. <code>RTools4.3</code>
+for R version 4.3).</p>
+</blockquote>
 <h2 id="notes-for-contributors">Notes for contributors</h2>
 <h3 id="dependencies">Dependencies</h3>
 <ul>
@@ -689,12 +697,11 @@ <h4 id="style">Style</h4>
 <li>Always assign <code>&lt;-</code>, not <code>=</code></li>
 </ul></li>
 </ul>
-<h4 id="approach">Approach</h4>
+<h4 id="paradigm">Paradigm</h4>
 <ul>
-<li>Those coming from an object oriented language (like Python), please
-observe R’s <a href="https://adv-r.hadley.nz/fp.html">functional
-approach</a> together with the native pipe operator <code>|&gt;</code>
-to prevent scope mess.</li>
+<li>Please stick to R’s <a href="https://adv-r.hadley.nz/fp.html">functional approach</a> and make
+liberal use of the native pipe operator <code>|&gt;</code> to prevent
+scope mess and increase readability.</li>
 </ul>
 <!-- general advice for contributors, include in README ?
 &#10;### Tools for enforcing style

diff --git a/README.md b/README.md
@@ -31,14 +31,22 @@ schema notation.
 
 ### Installation from GitHub
 
-This **R** package ist available from GitHub only. Use {remotes} or
-{pacman} to install from GitHub:
+This **R** package ist available from GitHub only. Use
+[{remotes}](https://cran.r-project.org/web/packages/remotes/index.html)
+or [{pacman}](https://cran.r-project.org/web/packages/pacman/index.html)
+to install from the GitHub source:
 
       ## install {remotes} if necessary:
       if(!require("remotes")) install.packages("remotes")
       ## fetch and install {validiraptor}:
       remotes::install_github("eLTER-RI/validiraptor")
 
+> On Windows, you need to download and install
+> [Rtools](https://cran.r-project.org/bin/windows/Rtools/rtools43/rtools.html)
+> to compile the source files retrieved from GitHub. Make sure to
+> install the Rtools compatible with your R version (e. g. `RTools4.3`
+> for R version 4.3).
+
 ## Notes for contributors
 
 ### Dependencies
@@ -68,11 +76,12 @@ guidelines when writing code for this project:
     except in function arguments.
   - Always assign `<-`, not `=`
 
-#### Approach
+#### Paradigm
 
-- Those coming from an object oriented language (like Python), please
-  observe R’s [functional approach](https://adv-r.hadley.nz/fp.html)
-  together with the native pipe operator `|>` to prevent scope mess.
+- Please stick to R’s [functional
+  approach](https://adv-r.hadley.nz/fp.html) and make liberal use of the
+  native pipe operator `|>` to prevent scope mess and increase
+  readability.
 
 <!-- general advice for contributors, include in README ?
 &#10;### Tools for enforcing style