Skip to content

Commit

Permalink
add conda installation to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
apriltuesday committed Jan 2, 2024
1 parent 0ace319 commit 63da22a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,19 @@ nextflow run ${CODE_ROOT}/pipelines/annotation_pipeline.nf \
--mappings ${LATEST_MAPPINGS}
```

### Conda

You can also install CMAT using Conda.
For example the following installs CMAT in a new environment called `cmat`, activates the environment, and prints usage:
```bash
conda create -n cmat -c conda-forge -c bioconda cmat
conda activate cmat
cmat
```

Note that with conda installation you can't invoke the pipelines directly via Nextflow, so you will need to use the corresponding `cmat` commands - e.g. `cmat annotate` instead of `nextflow run annotation_pipeline.nf`.
All the same command line options apply.

## Run

CMAT includes a main annotation pipeline (which also performs consequence and gene mapping), as well as two pipelines to help manage trait mapping curation.
Expand Down

0 comments on commit 63da22a

Please sign in to comment.