annotate 0.2.0/README.md @ 0:9e8b1c747a6a draft default tip

planemo upload
author galaxytrakr
date Fri, 29 May 2026 13:32:17 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
1 # `cronology`
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
2
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
3 `cronology` is an automated workflow for **_Cronobacter_** whole genome sequence assembly, subtyping and traceback based on [NCBI Pathogen Detection](https://www.ncbi.nlm.nih.gov/pathogens) Project for [Cronobacter](https://www.ncbi.nlm.nih.gov/pathogens/isolates/#taxgroup_name:%22Cronobacter%22). At present, only short-read data is supported with long-read support and hybrid assembly planned in future versions. Future roadmap also includes support for Metagenomics.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
4
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
5 It is written in **Nextflow** and is part of the modular data analysis pipelines (**CFSAN PIPELINES** or **CPIPES** for short) at **CFSAN**.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
6
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
7 \
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
8  
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
9
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
10 ## Workflows
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
11
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
12 `cronology`: [README](./readme/cronology.md).
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
13
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
14 \
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
15  
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
16
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
17 ### Citing `cronology`
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
18
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
19 ---
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
20 This work is currently unpublished. Please cite our **GitHub** page.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
21
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
22 >
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
23 >**cronology: An automated bioinformatics workflow for _Cronobacter_ whole genome sequence assembly, subtyping and traceback.**
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
24 >
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
25 >Kranti Konganti, Padmini Ramachandran, Monica Pava-Ripoll, Karen Jarvis, Maria Balkey, Ruth Timme, Gopal Gopinathrao, Yi Chen, and Chris Grim. _**CFSAN, FDA**_. [https://github.com/CFSAN-Biostatistics/cronology](https://github.com/CFSAN-Biostatistics/cronology).
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
26 >
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
27
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
28 \
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
29  
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
30
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
31 ### Ribosomal Multilocus Sequence Typing (rMLST)
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
32
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
33 ---
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
34 Use of `rMLST` as part of `cronology` is only for academic and non commercial use only.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
35
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
36 >
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
37 >For full terms and conditions please see [rMLST_licence.pdf](https://pubmlst.org/static/rmlst/rMLST_licence.pdf). To discuss any other sort of use, including a commercial use licence, please contact <innovation@innovation.ox.ac.uk> quoting reference 7895/MC.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
38 >
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
39
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
40 \
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
41 &nbsp;
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
42
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
43 ### Caveats
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
44
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
45 ---
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
46
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
47 - The main workflow has been used for **research purposes** only.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
48 - 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.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
49 - Internet access is required for succesful completion since the pipeline uses **Ribosomal MLST** (**RMLST**) for **_Cronobacter_** species identification using **PubMLST** API calls.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
50
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
51 \
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
52 &nbsp;
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
53
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
54 ### Acknowledgements
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
55
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
56 ---
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
57 **NCBI Pathogen Detection**:
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
58
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
59 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.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
60
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
61 \
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
62 &nbsp;
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
63
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
64 ### Disclaimer
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
65
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
66 ---
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
67 **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.