Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SPPearce committed Jul 6, 2023
1 parent 116b893 commit 51e2634
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,8 @@ NGSCheckMate is a software package for identifying next generation sequencing (N

NGSCheckMate paper is now published in [_Nucleic Acids Research_](https://academic.oup.com/nar/article-lookup/doi/10.1093/nar/gkx193).


* pdf documentation is included in the package. [Documentation.pdf](Documentation.pdf)



## Table of contents
* [Requirements](#requirements)
* [Installation](#installation)
Expand Down Expand Up @@ -96,6 +93,14 @@ cd $NCM_HOME
source install_ncmfastq.sh
```

#### Containers
The tool is available through software containers for ease of installation:
* Docker: https://quay.io/repository/biocontainers/ngscheckmate?tab=tags&tag=latest
* Singularity/Apptainer: https://depot.galaxyproject.org/singularity/ngscheckmate:1.0.0--py27r41hdfd78af_3
* Conda: `bioconda::ngscheckmate=1.0.0`

Additionally, there is a Nextflow subworkflow for use on bam files available as part of the nf-core project, https://github.com/nf-core/modules/blob/master/subworkflows/nf-core/bam_ngscheckmate/main.nf.

## Usage
#### 1) BAM/VCF mode
```
Expand Down

0 comments on commit 51e2634

Please sign in to comment.