Skip to content

Commit

Permalink
Update README.md to add lib argument to install_github
Browse files Browse the repository at this point in the history
  • Loading branch information
mano-at-sdsc authored Jan 31, 2024
1 parent 0fcb92f commit 912e973
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,27 @@ These R-based tools enable users to map a list of metabolite names (from a text
To install the current version:

``` r
# For Windows:

devtools::install_github("metabolomicsworkbench/RefMet")

# If permission issues prevent installation, lib argument can be specified similar to as explained below for the Linux platform below.

# For linux: The use may not have write permission in the standard install location,
# such as, /usr/lib64/R/library, so, one can install it in the user area. The lib argument
# of install_github specifies the library location, e.g., user can specify a subfolder
# in their account where they have write-privilege. In the lib location below, please ensure
# that the subfolder .local/R exists in the user account, else, create it using the linux command mkdir.

USER_HOME=Sys.getenv("HOME");
devtools::install_github("metabolomicsworkbench/RefMet", lib = paste0(USER_HOME, "/.local/R"))

```

Load RefMet in R:
Load RefMet in R: For linux, first add paste0(USER_HOME, "/.local/R") to library path.

``` r
.libPaths( c( .libPaths(), paste0(USER_HOME, "/.local/R") )); # Linux only
library(RefMet)
```

Expand Down

0 comments on commit 912e973

Please sign in to comment.