Improve R package installation guidance

aehrc · Dec 2, 2023 · 421c701 · 421c701
1 parent 5966943
commit 421c701
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 16 deletions.
diff --git a/lib/R/README.md b/lib/R/README.md
@@ -7,13 +7,22 @@ that aid the use of FHIR terminology services and FHIR data within R code.
 
 ## Local installation
 
-Prerequisites: `R >= 3.5.0` (has been tested with `R 4.3.1`)
+Prerequisites:
 
-* Install the `remotes` package: `install.packages('remotes')`
-* Install the `pathling`
-  package: `remotes::install_url('https://pathling.csiro.au/R/pathling_6.4.0.tar.gz', upgrade = FALSE)`
-* Install Spark version required by
-  Pathling: `pathling::pathling_install_spark()`
+- R >= 3.5.0 (tested with 4.3.1)
+
+To install, run these commands:
+
+```r
+# Install the `remotes` package.
+install.packages('remotes')
+
+# Install the `pathling` package.
+remotes::install_url('https://pathling.csiro.au/R/pathling_6.4.0.tar.gz', upgrade = FALSE)
+
+# Install the Spark version required by Pathling.
+pathling::pathling_install_spark()
+```
 
 ### Running on Windows
 

diff --git a/site/docs/libraries/index.md b/site/docs/libraries/index.md
@@ -8,8 +8,15 @@ sidebar_label: Introduction
 Pathling provides a set of libraries that provide assistance with
 using [FHIR](https://hl7.org/fhir)
 and [terminology services](https://hl7.org/fhir/terminology-service.html) from
-Apache Spark applications and data science workflows. The libraries are
-available for Python, Scala and Java.
+Apache Spark applications and data science workflows.
 
-We also have upcoming support for R, subscribe to
-[this issue](https://github.com/aehrc/pathling/issues/193) for updates.
+The libraries are available for:
+
+- [Python](pathname:///docs/python/pathling.html) (based on [PySpark](https://spark.apache.org/docs/latest/api/python/reference/index.html))
+- [R](pathname:///docs/r/index.html) (based on [sparklyr](https://spark.rstudio.com/))
+- [Scala](pathname:///docs/scala/au/csiro/pathling/index.html)
+- [Java](pathname:///docs/java/index.html)
+
+All the different Pathling library implementations allow you to run queries 
+locally (which is the default), or connect to a remote Spark cluster for 
+processing of large datasets.
diff --git a/site/docs/libraries/installation/index.md b/site/docs/libraries/installation/index.md
@@ -18,13 +18,22 @@ pip install pathling
 
 ### R
 
-Prerequisites: `R >= 3.5.0` (has been tested with `R 4.3.1`)
+Prerequisites: 
 
-* Install the `remotes` package: `install.packages('remotes')`
-* Install the `pathling`
-  package: `remotes::install_url('https://pathling.csiro.au/R/pathling_6.4.0.tar.gz', upgrade = FALSE)`
-* Install Spark version required by
-  Pathling: `pathling::pathling_spark_install()`
+- R >= 3.5.0 (tested with 4.3.1)
+
+To install, run these commands:
+
+```r
+# Install the `remotes` package.
+install.packages('remotes')
+
+# Install the `pathling` package.
+remotes::install_url('https://pathling.csiro.au/R/pathling_6.4.0.tar.gz', upgrade = FALSE)
+
+# Install the Spark version required by Pathling.
+pathling::pathling_install_spark()
+```
 
 ### Scala