Skip to content

Commit

Permalink
Update R documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
woodthom2 committed Oct 2, 2023
1 parent 7799357 commit 962498b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
20 changes: 11 additions & 9 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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
Expand Down
6 changes: 5 additions & 1 deletion content/en/blog/harmony_r_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")`.

Expand Down

0 comments on commit 962498b

Please sign in to comment.