You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -345,19 +345,20 @@ The metaWEPP Snakemake pipeline requires the following arguments, which can be p
345
345
1.`DIR` - Folder containing the metagenomic reads.
346
346
2.`KRAKEN_DB` - Folder containing the Kraken2 database.
347
347
3.`SEQUENCING_TYPE` - Sequencing read type (s:Illumina single-ended, d:Illumina double-ended, or n:ONT long reads)
348
-
4.`PRIMER_BED` - BED file argument for primers, which requires path to the file.
348
+
4.`PRIMER_BED` - BED file argument for primers, which requires complete path to the file.
349
349
5.`MIN_AF` - Alleles with an allele frequency below this threshold in the reads will be masked (Illumina: 0.5%, Ion Torrent: 1.5%, ONT: 2%) by WEPP.
350
350
6.`MIN_DEPTH` - Sites with read depth below this threshold will be masked by WEPP.
351
351
7.`MIN_Q` - Alleles with a Phred score below this threshold in the reads will be masked by WEPP.
352
352
8.`MIN_PROP` - Minimum Proportion of haplotypes detected by WEPP (Wastewater Samples: 0.5%, Clinical Samples: 5%).
353
353
9.`MIN_LEN` - Minimum read length to be considered after ivar trim (Default: 80).
354
354
10.`MAX_READS` - Maximum number of reads considered by WEPP from the sample. Helpful for reducing runtime.
355
-
11.`DASHBOARD_ENABLED` - Enables WEPP dashboard for visualization of haplotype results
356
-
12.`PATHOGENS` - List of pathogens with custom WEPP settings. Any species not listed here will use the `default` settings.
357
-
12.`CLADE_LIST` - Comma-separated list of clade annotation schemes present in the MAT file. Each element corresponds to the pathogen species in the order specified in `PATHOGENS`. If there is no clade annotation for a pathogen species, do not provide any value for that species.
358
-
13.`CLADE_IDX` - Comma-separated list of clade indices for each pathogen. If a pathogen has no lineage annotations, use **-1**. Each element corresponds to the pathogen species in the order specified by `PATHOGENS`.
359
-
14.`MIN_DEPTH_FOR_WEPP` - Minimum read coverage required to run WEPP for any pathogen species.
360
-
15.`MIN_PROP_FOR_WEPP` - Minimum relative abundance of a species before metaWEPP prompts to add it for haplotype-level analysis.
355
+
11.`DASHBOARD_ENABLED` - Enables WEPP dashboard for visualization of haplotype results.
356
+
12.`ADD_SPECIES_RUNTIME` - Asks users to add pathogen species at runtime when enabled.
357
+
13.`PATHOGENS` - List of pathogens with custom WEPP settings. Any species not listed here will use the `default` settings.
358
+
14.`CLADE_LIST` - Comma-separated list of clade annotation schemes present in the MAT file. Each element corresponds to the pathogen species in the order specified in `PATHOGENS`. If there is no clade annotation for a pathogen species, do not provide any value for that species.
359
+
15.`CLADE_IDX` - Comma-separated list of clade indices for each pathogen. If a pathogen has no lineage annotations, use **-1**. Each element corresponds to the pathogen species in the order specified by `PATHOGENS`.
360
+
16.`MIN_DEPTH_FOR_WEPP` - Minimum read coverage required to run WEPP for any pathogen species.
361
+
17.`MIN_PROP_FOR_WEPP` - Minimum relative abundance of a species before metaWEPP prompts to add it for haplotype-level analysis.
361
362
362
363
363
364
#### <aname="argexample"> Example of species-specific arguments:
0 commit comments