nf-core_modules/modules/shovill/meta.yml
Harshil Patel e937c7950a
Rename software/ directory to modules/ to re-organise module structure (#567)
* Update README

* Rename pytest_software.yml to pytest_modules.yml

* Rename main software directory to modules

* Remove deprecated modules

* Rename tests software to modules

* Replace paths for tests in pytest_modules.yml

* Replace software with modules in Github Actions

* Replace software with modules in main.nf tests

* Rename software to modules in test.yml
2021-07-07 10:10:18 +01:00

59 lines
1.7 KiB
YAML

name: shovill
## TODO nf-core: Add a description of the module and list keywords
description: Assemble bacterial isolate genomes from Illumina paired-end reads
keywords:
- bacterial
- assembly
- illumina
tools:
- shovill:
## TODO nf-core: Add a description and other details for the software below
description: Microbial assembly pipeline for Illumina paired-end reads
homepage: https://github.com/tseemann/shovill
documentation: https://github.com/tseemann/shovill/blob/master/README.md
licence: ['GPL v2']
input:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- reads:
type: file
description: List of input paired-end FastQ files
output:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- version:
type: file
description: File containing software version
pattern: "*.{version.txt}"
- contigs:
type: file
description: The final assembly produced by Shovill
pattern: "contigs.fa"
- corrections:
type: file
description: List of post-assembly corrections made by Shovill
pattern: "shovill.corrections"
- log:
type: file
description: Full log file for bug reporting
pattern: "shovill.log"
- raw_contigs:
type: file
description: Raw assembly produced by the assembler (SKESA, SPAdes, MEGAHIT, or Velvet)
pattern: "{skesa,spades,megahit,velvet}.fasta"
- gfa:
type: file
description: Assembly graph produced by MEGAHIT, SPAdes, or Velvet
pattern: "contigs.{fastg,gfa,LastGraph}"
authors:
- "@rpetit3"