Skip to content

Commit

Permalink
Updated installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
florian-j-auer committed Oct 5, 2022
1 parent 6b5dbee commit 4e1bf0b
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 6 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,31 @@ Model](vignettes/Appendix_The_RCX_and_CX_Data_Model.Rmd)
Installation
============

For installing packages from github the `devtools` package is the most common approach.
However, it requires XML libraries installed on the system which can cause problems while installation due to unmet dependencies.
The `remotes` package covers the functionality to download and install R packages stored in 'GitHub', 'GitLab', 'Bitbucket', 'Bioconductor', or plain 'subversion' or 'git' repositories without depending on XML libraries.
If `devtools` is already installed, of course it can be used, otherwise it is recommended to use the lightweight `remotes` package.

**From github using remotes:**

``` r
if(!"remotes" %in% installed.packages()){
install.packages("remotes")
}
if(!"RCX" %in% installed.packages()){
remotes::install_github("frankkramer-lab/RCX")
}
library(RCX)
```

**From github using devtools:**

``` r
if (!"RCX" %in% installed.packages()) {
require(devtools)
install_github("frankkramer-lab/RCX")
if(!"devtools" %in% installed.packages()){
install.packages("devtools")
}
if(!"RCX" %in% installed.packages()){
devtools::install_github("frankkramer-lab/RCX")
}
library(RCX)
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,18 +76,41 @@ For an overview of the differences of the RCX implementation to the CX specifica

# Installation

For installing packages from github the `devtools` package is the most common approach.
However, it requires XML libraries installed on the system which can cause problems while installation due to unmet dependencies.
The `remotes` package covers the functionality to download and install R packages stored in 'GitHub', 'GitLab', 'Bitbucket', 'Bioconductor', or plain 'subversion' or 'git' repositories without depending on XML libraries.
If `devtools` is already installed, of course it can be used, otherwise it is recommended to use the lightweight `remotes` package.

**From github using remotes:**

```{r, eval=FALSE}
if(!"remotes" %in% installed.packages()){
install.packages("remotes")
}
if(!"RCX" %in% installed.packages()){
require(devtools)
install_github("frankkramer-lab/RCX")
remotes::install_github("frankkramer-lab/RCX")
}
library(RCX)
```

**From github using devtools:**

```{r installBioconductor, eval=FALSE, include=FALSE}
```{r, eval=FALSE}
if(!"devtools" %in% installed.packages()){
install.packages("devtools")
}
if(!"RCX" %in% installed.packages()){
devtools::install_github("frankkramer-lab/RCX")
}
library(RCX)
```


```{r installBioconductor, eval=FALSE, include=FALSE}
if(!"BiocManager" %in% installed.packages()){
install.packages("BiocManager")
}
if(!"RCX" %in% installed.packages()){
BiocManager::install("RCX")
}
library(RCX)
Expand Down

0 comments on commit 4e1bf0b

Please sign in to comment.