nf-core_modules/software/last/lastdb/meta.yml
Charles Plessy 16d20a7cc4
New last/lastdb module to index sequences before alignment. (#476)
* New last/lastdb module to index sequences before alignment.

The `lastdb` command creates a sequence index for the LAST aligner
(https://gitlab.com/mcfrith/last). Input can be in FASTA or FASTQ
format, and compression is handled automagically.  DNA or protein
sequences can be indexed.

The sequence index is a collection of files sharing the same basename.
This module sets the basename to the sample identifier (`$meta.id`) and
creates the index in a directory always called `lastdb`.  The module's
output channel then conveys a copy of the metadata and the path to the
`lastdb` directory.

Other modules will follow (see Issue #464).  The LAST aligner can align
proteins to proteins, DNA to DNA and can translate DNA align to
proteins.

* Remove trailing whitespace.

* Apply suggestions from code review

Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>

* Update as suggested in PR.

* Attempt to pass linting.

Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>

Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>
2021-05-02 11:36:31 +01:00

41 lines
1.1 KiB
YAML

name: last_lastdb
description: Prepare sequences for subsequent alignment with lastal.
keywords:
- LAST
- index
- fasta
- fastq
tools:
- last:
description: LAST finds & aligns related regions of sequences.
homepage: https://gitlab.com/mcfrith/last
documentation: https://gitlab.com/mcfrith/last/-/blob/main/doc/lastdb.rst
tool_dev_url: https://gitlab.com/mcfrith/last
doi: ""
licence: ['GPL-3.0-or-later']
input:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- fastx:
type: file
description: >
Sequence file in FASTA or FASTQ format.
May be compressed with gzip.
pattern: "*.{fasta,fasta.gz,fastq,fastq.gz}"
output:
- version:
type: file
description: File containing software version
pattern: "*.{version.txt}"
- index:
type: directory
description: directory containing the files of the LAST index
pattern: "lastdb/"
authors:
- "@charles-plessy"