@@ -20,5 +20,36 @@ The samplesheet table has the following layout:
2020| sample | species | strain | id_prefix | file |
2121| ------ | ------------------------ | ------ | --------- | -------------- |
2222| EC2224 | "Streptococcus pyogenes" | SF370 | SPY | assembly.fasta |
23+ | ... | ... | ... | ... | ... |
2324
24- ** Note:** Pangenome analysis with ` Panaroo ` requires at least two samples.
25+ ** Note:** Pangenome analysis with ` Panaroo ` requires at least two samples.
26+
27+ ### Parameters
28+
29+ This table lists all parameters that can be used to run the workflow.
30+
31+ | Parameter | Type | Details | Default |
32+ | :---| :---| :---| :---|
33+ | ** samplesheet** | string | Path to the sample sheet file in csv format | |
34+ | ** tool** | array[ string] | Annotation tool to use (one of ` prokka ` , ` pgap ` , ` bakta ` ) | |
35+ | ** pgap** | | PGAP configuration object | |
36+ | bin | string | Path to the PGAP script | |
37+ | use_yaml_config | boolean | Whether to use YAML configuration for PGAP | ` False ` |
38+ | _ prepare_yaml_files_ | | Paths to YAML templates for PGAP | |
39+ | generic | string | Path to the generic YAML configuration file | |
40+ | submol | string | Path to the submol YAML configuration file | |
41+ | ** prokka** | | Prokka configuration object | |
42+ | center | string | Center name for Prokka annotation (used in sequence IDs) | |
43+ | extra | string | Extra command-line arguments for Prokka | |
44+ | ** bakta** | | Bakta configuration object | |
45+ | download_db | string | Bakta database type (` full ` , ` light ` , or ` none ` ) | ` light ` |
46+ | existing_db | string | Path to an existing Bakta database (optional). Needs to be combined with ` download_db='none' ` | |
47+ | extra | string | Extra command-line arguments for Bakta | |
48+ | ** quast** | | QUAST configuration object | |
49+ | reference_fasta | string | Path to the reference genome for QUAST | |
50+ | reference_gff | string | Path to the reference annotation for QUAST |
51+ | extra | string | Extra command-line arguments for QUAST | |
52+ | ** panaroo** | | Panaroo configuration object | |
53+ | remove_source | string | Source types to remove in Panaroo (regex supported) | ` cmsearch ` |
54+ | remove_feature | string | Feature types to remove in Panaroo (regex supported) | ` tRNA\|rRNA\|ncRNA\|exon\|sequence_feature ` |
55+ | extra | string | Extra command-line arguments for Panaroo | |
0 commit comments