Skip to content

Commit

Permalink
One more README update
Browse files Browse the repository at this point in the history
  • Loading branch information
anngvu committed Nov 15, 2024
1 parent c8ef9b8 commit f5e7987
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,16 @@ You will have to set up both (see #Installation). Outside of the tested versions

## Installation

This presumes you have already set up R with RStudio.

1. Install `reticulate` following guide at https://rstudio.github.io/reticulate/index.html#installation.
2. Install `synapseclient==4.3.1` following https://rstudio.github.io/reticulate/articles/python_packages.html, which will use a default environment "r-reticulate".
3. Lastly, install `nfportalutils`: `remotes::install_github("nf-osi/nfportalutils")`.
At startup, `nfportalutils` imports `synapseclient` from the default "r-reticulate".
3. Lastly, install `nfportalutils`. At startup, `nfportalutils` imports `synapseclient` from the default "r-reticulate".
- As regular users: `remotes::install_github("nf-osi/nfportalutils", build_vignettes = TRUE)` or `remotes::install_github("nf-osi/nfportalutils@some-branch", build_vignettes = TRUE)`
- For developers, presumably working with `devtools`:
- Clone the repo, checkout your desired development branch.
- Make sure the package repo root is working directory, then in R run `devtools::install()`.
4. Browse some vignettes: `browseVignettes("nfportalutils")`.

## For Users

Expand Down

0 comments on commit f5e7987

Please sign in to comment.