Update R installation instructions, close #71 (#72)

Urban-Analytics-Technology-Platform · Sep 10, 2024 · 4ad8433 · 4ad8433
1 parent 27fff32
commit 4ad8433
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 10 deletions.
diff --git a/r/README.md b/r/README.md
@@ -4,6 +4,16 @@
 This R package provides functions to prepare OD data for network
 generation with the `od2net` tool, as illustrated in the example below.
 
+## Installation
+
+``` r
+# Install pak if not already installed:
+if (!requireNamespace("pak", quietly = TRUE)) {
+  install.packages("pak")
+}
+pak::pkg_install("Urban-Analytics-Technology-Platform/od2net/r")
+```
+
 ## Example
 
 Imagine you want to generate a route network with values on the links
@@ -78,11 +88,6 @@ make_elevation = function(
 </details>
 
 ``` r
-# Install pak if not already installed:
-if (!requireNamespace("pak", quietly = TRUE)) {
-  install.packages("pak")
-}
-pak::pkg_install("robinlovelace/od2net/r@67-r-port")
 dir.create("input", showWarnings = FALSE)
 # Get some zones from a URL:
 uz = "https://github.com/acteng/netgen/raw/main/input/zones_york.geojson"

diff --git a/r/README.qmd b/r/README.qmd
@@ -10,6 +10,16 @@ execute:
 
 This R package provides functions to prepare OD data for network generation with the `od2net` tool, as illustrated in the example below.
 
+## Installation
+
+```{r}
+# Install pak if not already installed:
+if (!requireNamespace("pak", quietly = TRUE)) {
+  install.packages("pak")
+}
+pak::pkg_install("Urban-Analytics-Technology-Platform/od2net/r")
+```
+
 ## Example
 
 Imagine you want to generate a route network with values on the links representing the number of pupils/parents on their way to school each school day. The following code shows how to prepare the data for the `od2net` tool.
@@ -83,11 +93,6 @@ make_elevation = function(
 
 ```{r}
 #| eval: false
-# Install pak if not already installed:
-if (!requireNamespace("pak", quietly = TRUE)) {
-  install.packages("pak")
-}
-pak::pkg_install("robinlovelace/od2net/r@67-r-port")
 dir.create("input", showWarnings = FALSE)
 # Get some zones from a URL:
 uz = "https://github.com/acteng/netgen/raw/main/input/zones_york.geojson"