Skip to content

Commit

Permalink
Update README.md to include installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
iblacksand authored Apr 29, 2024
1 parent bcf8011 commit 5df4289
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,28 @@ WebGestaltR function can perform popular enrichment analyses: ORA (Over-Represen
## Installation


---

### Requirements

- R (>= 4.0.0)
- Rust (>= 1.63.0)

---

Since WebGestaltR v1.0.0, Rust is used for core computations in the R package. Therefore, to install WebGestaltR, please download and install Rust from [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install). For Mac, Linux, or Unix users, Rust can be installed from the command line, and Windows users can download a GUI installer.

Make sure you restart your terminal after installing Rust to ensure the Rust compiler is available in your path. You can check that Rust is installed correctly by running `rustc --version` in your terminal.

After installing Rust, you can install WebGestaltR by running the following command in an R session:

```R
# install.packages("devtools") # run if devtools not already installed
devtools::install_github("bzhanglab/WebGestaltR")
```

During installation, the Rust compiler will be called to build the computation library used by WebGestaltR. If you run into problems with installation of the new version, please [open a new issue](https://github.com/bzhanglab/WebGestaltR/issues/new/choose).


## Changes

Expand Down

0 comments on commit 5df4289

Please sign in to comment.