annotate 0.4.2/README.md @ 0:082e0091e813 draft default tip

planemo upload
author galaxytrakr
date Fri, 29 May 2026 13:27:47 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
1 # `centriflaken`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
2
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
3 `centriflaken` is an automated precision metagenomics workflow for assembly and _in silico_ analyses of food-borne pathogens. `centriflaken` primarily fine-tuned for detecting and classifying Shiga toxin-producing **_Escherichia coli_** (**STEC**), can also be used for performing analyses on other food-borne pathogens such as **_Salmonella enterica_**. `centriflaken` takes as input a UNIX path to FASTQ, generates MAGs, and performs in silico-based analysis for STECs as described in [Maguire et al. 2021](https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0245172).
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
4
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
5 `centriflaken` works on both **Illumina** short reads and **Oxford Nanopore** long reads.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
6
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
7 It is written in **Nextflow** and is part of the modular data analysis pipelines at **HFP**.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
8
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
9 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
10  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
11
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
12 ## Workflows
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
13
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
14 **CPIPES**:
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
15
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
16 - `centriflaken` : [README](./readme/centriflaken.md).
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
17 - `centriflaken_hy` : [README](./readme/centriflaken.md#illumina-short-reads).
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
18
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
19 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
20  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
21
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
22 ### Citing `centriflaken`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
23
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
24 ---
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
25 Manuscript in preparation.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
26
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
27 >
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
28 >**centriflaken: an automated data analysis pipeline for assembly and in silico analyses of food-borne pathogens from metagenomic samples.**
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
29 >
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
30 >Kranti Konganti, Julie Kase, and Narjol Gonzalez-Escalona.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
31 >
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
32
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
33 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
34  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
35
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
36 ### Future work
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
37
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
38 ---
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
39
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
40 - Incorporation of ANI methods to speed up the analysis methods.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
41 - Incorporation of Oxford Nanopore models for barcode level assembly.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
42
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
43 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
44  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
45
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
46 ### Caveats
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
47
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
48 ---
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
49
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
50 - The main workflow has been used for **research purposes** only.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
51 - Analysis results should be interpreted with caution.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
52
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
53 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
54  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
55
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
56 ### Disclaimer
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
57
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
58 ---
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
59 **HFP, 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, **HFP, 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 **HFP, FDA** or confers any advantage in regulatory decisions.