From 962498b89263f8f591034a47806dfef04ff28d37 Mon Sep 17 00:00:00 2001 From: Thomas Wood Date: Mon, 2 Oct 2023 09:40:26 +0100 Subject: [PATCH] Update R documentation --- content/en/_index.md | 20 +++++++++++--------- content/en/blog/harmony_r_example.md | 6 +++++- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/content/en/_index.md b/content/en/_index.md index ffdc01d2..871c848b 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -57,10 +57,6 @@ blocks: url: http://github.com/harmonydata/harmony - text: Google Colab notebook url: https://colab.research.google.com/github/harmonydata/harmony/blob/main/Harmony_example_walkthrough.ipynb - - text: REST API - url: http://github.com/harmonydata/harmonyapi - - text: REST API Documentation (PDF/Swagger) - url: https://raw.githubusercontent.com/harmonydata/harmonyapi/main/docs/API_reference.pdf code: | ```vshell pip install harmonydata @@ -83,10 +79,14 @@ blocks: url: https://github.com/harmonydata/harmony_r - text: Documentation url: /harmony-r-released/ - - text: Example notebook + - text: Google Colab notebook url: "https://github.com/harmonydata/experiments/blob/main/Harmony_R_example.ipynb" + - text: R markdown notebook for R Studio + url: "/harmony_r_example.nb.html" - text: CRAN url: "https://cran.r-project.org/web/packages/harmonydata/index.html" + - text: Windows installation video + url: "https://www.youtube.com/watch?v=hFqg6T_BqZc" code: | ```vshell # install.packages("devtools") # If you don't have devtools installed already or CRAN is down. @@ -104,13 +104,15 @@ blocks: - block: feature-2 # padding: top align: right - heading: "Harmony Docker container" - subheading: We've released Harmony as a Docker container on [Dockerhub](https://hub.docker.com/). + heading: "Harmony Docker container/API" + subheading: We've released Harmony as a Docker container on [Dockerhub](https://hub.docker.com/), running a REST API using FastAPI. links: - - text: Docker - url: https://www.docker.com/ - text: Dockerhub url: https://hub.docker.com/r/harmonydata/harmonywithtika + - text: REST API + url: http://github.com/harmonydata/harmonyapi + - text: REST API Documentation (PDF/Swagger) + url: https://raw.githubusercontent.com/harmonydata/harmonyapi/main/docs/API_reference.pdf code: | ```vshell docker pull harmonydata/harmonywithtika diff --git a/content/en/blog/harmony_r_example.md b/content/en/blog/harmony_r_example.md index 6cdc0917..399c9b85 100644 --- a/content/en/blog/harmony_r_example.md +++ b/content/en/blog/harmony_r_example.md @@ -14,7 +14,11 @@ Harmony was developed as a collaboration between [Ulster University](https://uls This is an [R Markdown](http://rmarkdown.rstudio.com) Notebook. When you execute code within the notebook, the results appear beneath the code. Click [here](/harmony_r_example.nb.html) to download this file in R Markdown notebook format. -Try executing this chunk by clicking the *Run* button within the chunk or by placing your cursor inside it and pressing *Ctrl+Shift+Enter*. +{{< youtube hFqg6T_BqZc >}} + +_Installation of Harmony R package on Windows 10._ + +When you've [downloaded the .Rmd file](/harmony_r_example.Rmd), you can open it in [R Studio](https://posit.co/download/rstudio-desktop/). You can execute any chunk by clicking the *Run* button within the chunk or by placing your cursor inside it and pressing *Ctrl+Shift+Enter*. First let's import Harmony. If you haven't already, you need to install it with `install.packages("harmonydata")`.