nf-core_modules/modules/hamronization/amrfinderplus/meta.yml
louperelo 1368164eb5
add module hamronization/amrfinderplus (#1888)
* add module hamronization/amrfinderplus

* deleted comments

* Apply suggestions from code review

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
2022-07-15 10:54:42 +02:00

61 lines
1.8 KiB
YAML

name: "hamronization_amrfinderplus"
description: Tool to convert and summarize AMRfinderPlus outputs using the hAMRonization specification.
keywords:
- amr
- antimicrobial resistance
- arg
- antimicrobial resistance genes
- reporting
- amrfinderplus
tools:
- "hamronization":
description: "Tool to convert and summarize AMR gene detection outputs using the hAMRonization specification"
homepage: "https://github.com/pha4ge/hAMRonization/blob/master/README.md"
documentation: "https://github.com/pha4ge/hAMRonization/blob/master/README.md"
tool_dev_url: "https://github.com/pha4ge/hAMRonization"
licence: "['GNU Lesser General Public v3 (LGPL v3)']"
input:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- report:
type: file
description: Output .tsv file from AMRfinderPlus
pattern: "*.tsv"
- format:
type: value
description: Type of report file to be produced
pattern: "tsv|json"
- software_version:
type: value
description: Version of AMRfinder used
pattern: "[0-9].[0-9].[0-9]"
- reference_db_version:
type: value
description: Database version of ncbi_AMRfinder used
pattern: "[0-9]-[0-9]-[0-9].[0-9]"
output:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- versions:
type: file
description: File containing software versions
pattern: "versions.yml"
- json:
type: file
description: hAMRonised report in JSON format
pattern: "*.json"
- tsv:
type: file
description: hAMRonised report in TSV format
pattern: "*.tsv"
authors:
- "@louperelo"