name: "samtools_collate"
description: shuffles and groups reads together by their names
keywords:
  - collate
  - bam
tools:
  - "samtools":
      description: "Tools for dealing with SAM, BAM and CRAM files"
      homepage: "http://www.htslib.org"
      documentation: "https://www.htslib.org/doc/samtools-collate.html"
      tool_dev_url: "https://github.com/samtools/samtools"
      doi: "10.1093/bioinformatics/btp352"
      licence: "['MIT']"

input:
  # Only when we have meta
  - meta:
      type: map
      description: |
        Groovy Map containing sample information
        e.g. [ id:'test', single_end:false ]
  - input:
      type: file
      description: BAM/CRAM/SAM file
      pattern: "*.{bam,cram,sam}"

output:
  #Only when we have meta
  - 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"
  - output:
      type: file
      description: Collated BAM/CRAM/SAM file
      pattern: "*.{bam,cram,sam}"

authors:
  - "@priyanka-surana"