Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,8 @@ This R package implements ColocBoost --- motivated and designed for colocalizati

## Installation

### Conda
Install major releases from conda (recommended)

```bash
conda install -c dnachun r-colocboost
```

### CRAN
Install released versions from cran
Install released versions from CRAN - pre-built packages are available on macOS and Windows

```r
install.packages("colocboost")
Expand All @@ -27,6 +20,25 @@ Install the development version from GitHub
devtools::install_github("StatFunGen/colocboost")
```

### Conda
Install major releases using pre-built conda package with a conda-compatible package manager (recommended)

Global pixi installation is the easiest way to use the conda package
```bash
pixi global install r-base # Install r-base as a global package if not already installed
pixi global install --environment r-base r-colocboost # Inject r-colocboost into r-base global environment
```
The package can also be added to a local pixi environment
```bash
pixi workspace channel add dnachun # Add the dnachun channel to the workspace
pixi add r-colocboost # Add r-colocboost as a dependency to the environment
```
Micromamba is recommended instead of conda or mamba for traditional conda environments
```bash
micromamba install -c dnachun r-colocboost
mamba install -c dnachun r-colocboost
conda install -c dnachun r-colocboost
```
## Usage

### Single-trait Fine-mapping (FineBoost)
Expand Down
61 changes: 0 additions & 61 deletions vignettes/Install.Rmd

This file was deleted.