Skip to content

Commit

Permalink
added pATLAS badge
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagofilipe12 committed Feb 19, 2018
1 parent 82fc7d1 commit de5400d
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
[![](https://img.shields.io/badge/nextflow->=0.27.3-blue.svg)](#)
[![](https://img.shields.io/badge/docker_mash-ready-green.svg)](https://hub.docker.com/r/tiagofilipe12/patlasflow_mash_screen/)
[![](https://img.shields.io/badge/docker_mapping-ready-green.svg)](https://hub.docker.com/r/tiagofilipe12/patlasflow_mapping/)
[![](https://img.shields.io/badge/pATLAS-1.x.x-lightgrey.svg)](https://github.com/tiagofilipe12/pATLAS)

A pipeline to run mash screen for pATLAS.
A pipeline to run mapping, mash screen and assembly methods for pATLAS.

# TOC

Expand All @@ -15,6 +16,21 @@ A pipeline to run mash screen for pATLAS.
* [Example run](#example-run)
* [TL;DR](#tldr)


## TL;DR

1. Read files must be placed in `<current working dir>/reads/` folder

2. Fasta files must be placed in `<current working dir>/fasta/` folder

3. Run the pipeline `nextflow run tiagofilipe12/pATLASflow` with the options you require:
* Assembly: `nextflow run tiagofilipe12/pATLASflow --assembly`
* Mapping: `nextflow run tiagofilipe12/pATLASflow --mapping`
* Mash screen: `nextflow run tiagofilipe12/pATLASflow --mash_screen`

Note: you can even run all approaches by doing:
`nextflow run tiagofilipe12/pATLASflow --assembly --mapping --mash_screen`

## Brief description

This Nextflow script is an implementation of [mash-wrapper](https://github.com/tiagofilipe12/mash_wrapper#mash-screen-for-read-samples)
Expand Down Expand Up @@ -71,16 +87,3 @@ Usage: nextflow run tiagofilipe12/pATLASflow [options] or nextflow run main.nf [

`nextflow run tiagofilipe12/pATLASflow --assembly`

## TL;DR

1. Read files must be placed in `<current working dir>/reads/` folder

2. Fasta files must be placed in `<current working dir>/fasta/` folder

3. Run the pipeline `nextflow run tiagofilipe12/pATLASflow` with the options you require:
* Assembly: `nextflow run tiagofilipe12/pATLASflow --assembly`
* Mapping: `nextflow run tiagofilipe12/pATLASflow --mapping`
* Mash screen: `nextflow run tiagofilipe12/pATLASflow --mash_screen`

Note: you can even run all approaches by doing:
`nextflow run tiagofilipe12/pATLASflow --assembly --mapping --mash_screen`

0 comments on commit de5400d

Please sign in to comment.