annotate 1.0.0/README.md @ 0:801b85b03a17 draft default tip

planemo upload
author galaxytrakr
date Thu, 28 May 2026 20:31:42 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
1 # `bettercallsal`
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
2
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
3 `bettercallsal` is an automated workflow to assign Salmonella serotype based on [NCBI Pathogen Detection](https://www.ncbi.nlm.nih.gov/pathogens) Project for [Salmonella](https://www.ncbi.nlm.nih.gov/pathogens/isolates/#taxgroup_name:%22Salmonella%20enterica%22). It uses `MASH` to reduce the search space followed by additional genome filtering with `sourmash`. It then performs genome based alignment with `kma` followed by count generation using `salmon`. This workflow can be used to analyze shotgun metagenomics datasets, quasi-metagenomic datasets (enriched for Salmonella) and target enriched datasets (enriched with molecular baits specific for Salmonella) and is especially useful in a case where a sample is of multi-serovar mixture.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
4
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
5 `bettercallsal` works on both **Illumina** short reads and **Oxford Nanopore** long reads.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
6
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
7 It is written in **Nextflow** and is part of the modular data analysis pipelines (**CFSAN PIPELINES** or **CPIPES** for short) at **CFSAN**.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
8
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
9 \
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
10  
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
11
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
12 ## Workflows
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
13
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
14 **CPIPES**:
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
15
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
16 1. `bettercallsal` : [README](./readme/bettercallsal.md).
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
17 2. `bettercallsal_db` : [README](./readme/bettercallsal_db.md).
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
18
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
19 \
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
20  
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
21
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
22 ### Citing `bettercallsal`
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
23
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
24 ---
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
25 This work is published in [Frontiers in Microbiology](https://www.frontiersin.org/articles/10.3389/fmicb.2023.1200983/full).
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
26
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
27 >
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
28 >**bettercallsal: better calling of _Salmonella_ serotypes from enrichment cultures using shotgun metagenomic profiling and its application in an outbreak setting**
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
29 >
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
30 >Kranti Konganti, Elizabeth Reed, Mark Mammel, Tunc Kayikcioglu, Rachel Binet, Karen Jarvis, Christina M. Ferreira, Rebecca Bell, Jie Zheng, Amanda M. Windsor, Andrea Ottesen, Christopher Grim, and Padmini Ramachandran. _**Frontiers in Microbiology**_. [https://doi.org/10.3389/fmicb.2023.1200983](https://www.frontiersin.org/articles/10.3389/fmicb.2023.1200983/full).
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
31 >
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
32
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
33 \
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
34  
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
35
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
36 ### Caveats
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
37
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
38 ---
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
39
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
40 - The main workflow has been used for **research purposes** only.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
41 - Analysis results should be interpreted with caution and should be treated as suspect, as the pipeline is dependent on the precision of metadata from the **NCBI Pathogen Detection** project for the `per_snp_cluster` and `per_computed_serotype` databases.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
42 - Internal research with simulated datasets suggests that the `bettercallsal` workflow is more accurate with increased read depth.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
43 - For Illumina MiSeq, at least 5 million read pairs (2x300 PE) or 10 million reads (1x300 SE) per sample works well.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
44 - For Illumina NextSeq and NovaSeq, around 10 million read pairs (2x150 PE) or 20 million reads (1x150 SE) per sample works well.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
45 - That being said, it is not a hard-cutoff and you can still try the workflow on low read-depth samples.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
46 - **No genome hit** assignment should be interpreted with caution.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
47
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
48 \
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
49  
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
50
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
51 ### Acknowledgements
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
52
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
53 ---
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
54 **NCBI Pathogen Detection**:
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
55
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
56 We gratefully acknowledge all data contributors, i.e., the Authors and their Originating laboratories responsible for obtaining the specimens, and their Submitting laboratories for generating the sequence and metadata and sharing it via the **NCBI Pathogen Detection** site, some of which this research utilizes.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
57
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
58 \
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
59  
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
60
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
61 ### Disclaimer
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
62
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
63 ---
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
64 **CFSAN, FDA** assumes no responsibility whatsoever for use by other parties of the Software, its source code, documentation or compiled or uncompiled executables, and makes no guarantees, expressed or implied, about its quality, reliability, or any other characteristic. Further, **CFSAN, FDA** makes no representations that the use of the Software will not infringe any patent or proprietary rights of third parties. The use of this code in no way implies endorsement by the **CFSAN, FDA** or confers any advantage in regulatory decisions.