annotate 0.5.0/README.md @ 0:3c767f9cfd88 draft default tip

planemo upload
author galaxytrakr
date Fri, 29 May 2026 13:37:56 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
1 <p align="center">
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
2 <img src="./assets/nowayout-icon.png" width="20%" height="20%" />
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
3 </p>
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
4
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
5 ---
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
6
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
7 `nowayout` is a **super-fast** automated software pipeline for taxonomic classification of Eukaryotic mitochondrial reads. It uses a custom database to first identify mitochondrial reads and performs read classification on those identified reads. This pipeline has been specifically used for detecting and identifying insects or insect fragments in foods and also has been used as a verification tool for labeling claims when insects are used as foods. `nowayout` can also be used to detect any Eukaryotic DNA from shotgun metagenomic datasets. The pipeline is under active rapid development and more research is being currently undertaken to solve the ambigous read assignments.
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
8
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
9 `nowayout` currently works on **Illumina** short reads and in future will support **Oxford Nanopore** long reads.
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
10
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
11 It is written in **Nextflow** and is part of the modular data analysis pipelines at **HFP**.
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
12
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
13 \
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
14 &nbsp;
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
15
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
16 ## Workflows
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
17
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
18 **CPIPES**:
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
19
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
20 - `nowayout` : [README](./readme/nowayout.md).
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
21
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
22 \
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
23 &nbsp;
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
24
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
25 ### Citing `nowayout`
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
26
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
27 ---
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
28 Manuscript is in preparation. Please cite our **GitHub** repo.
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
29
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
30 >
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
31 >**nowayout: an automated pipeline for taxonomic classification of Eukaryotic mitochondrial reads (<https://github.com/CFSAN-Biostatistics/nowayout>).**
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
32 >
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
33 >Kranti Konganti, Monica Pava-Ripoll, Amanda Windsor, Christopher Grim, Mark Mammel and Padmini Ramachandran
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
34 >
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
35
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
36 \
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
37 &nbsp;
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
38
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
39 ### Future work
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
40
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
41 ---
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
42
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
43 - Incorporation of custom algorithms and classification methods to deal with ambiguos read assignments.
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
44 - Incorporation of methods to support processing of Oxford Nanopore reads.
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
45
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
46 \
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
47 &nbsp;
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
48
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
49 ### Caveats
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
50
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
51 ---
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
52
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
53 - The main workflow has been used for **research purposes** only.
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
54 - Analysis results should be interpreted with caution.
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
55
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
56 \
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
57 &nbsp;
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
58
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
59 ### Disclaimer
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
60
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
61 ---
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
62 **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.