view 0.6.1/modules/mlst/README.md @ 12:c5faadb3386f

"planemo upload"
author kkonganti
date Tue, 05 Sep 2023 11:57:15 -0400
parents 749faef1caa9
children
line wrap: on
line source
# NextFlow DSL2 Module

```bash
MLST
```

## Description

Run `mlst` tool on a list of assembled contigs in FASTA format. Produces a single output table in ASCII text format.

\
 

### `input:`

___

Type: `tuple`

Takes in the following tuple of metadata (`meta`) and a list of assemled contig FASTA files of input type `path` (`fasta`).

Ex:

```groovy
[ [id: 'sample1', single_end: true], '/data/sample1/f_assembly.fa' ]
```

\
 

#### `meta`

Type: Groovy Map

A Groovy Map containing the metadata about the FASTQ file.

Ex:

```groovy
[ id: 'FAL00870', strandedness: 'unstranded', single_end: true ]
```

\
 

#### `fasta`

Type: `path`

NextFlow input type of `path` pointing to assembled contig file in FASTA format.

\
 

#### `args`

Type: Groovy String

String of optional command-line arguments to be passed to the tool. This can be mentioned in `process` scope within `withName:process_name` block using `ext.args` option within your `nextflow.config` file.

Ex:

```groovy
withName: 'MLST' {
    ext.args = '--nopath'
}
```

\
 

### `output:`

___

Type: `tuple`

Outputs a tuple of metadata (`meta` from `input:`) and list of `mlst` result files (`tsv`).

\
 

#### `tsv`

Type: `path`

NextFlow output type of `path` pointing to the `mlst` results table file per sample (`id:`).

\
 

#### `versions`

Type: `path`

NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.