Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
annacprice authored Jul 29, 2022
1 parent e5e9a40 commit a3bd889
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# TB Pipeline #
![Build Status](https://github.com/Pathogen-Genomics-Cymru/tb-pipeline/workflows/build-push-quay/badge.svg)

This pipeline takes as input reads presumed to be from one of 10 mycobacterial genomes: abscessus, africanum, avium, bovis, chelonae, chimaera, fortuitum, intracellulare, kansasii, tuberculosis. Input should be in the form of one directory containing pairs of fastq(.gz) or bam files.

Expand All @@ -7,7 +8,7 @@ Pipeline cleans and QCs reads with fastp and FastQC, classifies with Kraken2 & M
## Quick Start ##
Requires `NXF_VER>=20.11.0-edge`

The workflow is designed to run with either docker `-profile docker` or singularity `-profile singularity`. Before running the workflow, the images will need to be built by running either `docker/docker_build.sh` or `singularity/singularity_build.sh`
The workflow is designed to run with either docker `-profile docker` or singularity `-profile singularity`. The container images are pulled from quay and a singularity cache directory is set in the `nextflow.config`.

E.g. to run the workflow:
```
Expand Down

0 comments on commit a3bd889

Please sign in to comment.