Skip to content

Commit

Permalink
encourage use of Docker instead of Singularity; added example using s…
Browse files Browse the repository at this point in the history
…pecific workflow version
  • Loading branch information
chrisgulvik authored Mar 20, 2024
1 parent 47f00f3 commit 490f42e
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,36 +39,48 @@ Run the built-in test set to confirm all parts are working as-expected. It will
nextflow run \
bacterial-genomics/wf-paired-end-illumina-assembly \
-r main \
-profile singularity,test \
-profile docker,test \
--outdir my-results
```

## Quick Start: Run

Example command on FastQs in "new-fastq-dir" data using **SPAdes** with singularity:
Example command on FastQs in "new-fastq-dir" data using the **SPAdes** assembler (default) with the Docker container engine:

```bash
nextflow run \
bacterial-genomics/wf-paired-end-illumina-assembly \
-r main \
-profile singularity \
-profile docker \
--input new-fastq-dir \
--outdir my-results \
--assembler spades
--outdir my-results
```

Example command on FastQs in "new-fastq-dir" data using **SKESA** with singularity:
Example command on FastQs in "new-fastq-dir" data using the **SKESA** assembler with the Singularity container platform:

```bash
nextflow run \
bacterial-genomics/wf-paired-end-illumina-assembly \
-r main \
-profile singularity \
-profile docker \
--input new-fastq-dir \
--outdir my-results \
--assembler skesa
```

## Quick Start: Run Specific Workflow Version

Example command on FastQs in "new-fastq-dir" data using the **SPAdes** assembler (default) with the Docker container engine and a [supported version number](https://github.com/bacterial-genomics/wf-paired-end-illumina-assembly/tags) such as v2.3.0:

```bash
nextflow run \
bacterial-genomics/wf-paired-end-illumina-assembly \
-r v2.3.0 \
-profile docker \
--input new-fastq-dir \
--outdir my-results
```

## Introduction

This workflow assembles bacterial isolate genomes from paired-end Illumina FastQ files. Post-assembly contig correction is performed, and a variety of quality assessment processes are recorded throughout the workflow.
Expand Down

0 comments on commit 490f42e

Please sign in to comment.