README.md 3.2 KB
Newer Older
peguerin's avatar
peguerin committed
1
2
# Custom Metabarcoding Reference Database

peguerin's avatar
peguerin committed
3
4
5
[![Twitter Follow](https://img.shields.io/twitter/follow/ephe_bev?style=social)](https://twitter.com/ephe_bev)


peguerin's avatar
peguerin committed
6
7
## Introduction

peguerin's avatar
peguerin committed
8
**MKBDR** is a python program designed to create custom reference database from FASTA file using the NCBI taxonomy. It also provides tools to assist and perform taxonomy curation on the input FASTA file.
peguerin's avatar
peguerin committed
9
10
11



peguerin's avatar
peguerin committed
12
## Method
peguerin's avatar
peguerin committed
13

peguerin's avatar
peguerin committed
14
1. [Installation](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Installing-MKBDR)
peguerin's avatar
peguerin committed
15
2. [Input Files](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Files-definition#input-files)
peguerin's avatar
peguerin committed
16
    * [species representative records FASTA file](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Files-definition#representative-sequences)
peguerin's avatar
peguerin committed
17
    * [NCBI taxonomy files](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Files-definition#ncbi-taxonomies-file)
peguerin's avatar
peguerin committed
18
    * [Curation table file](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Files-definition#curation-file)
peguerin's avatar
peguerin committed
19
3. [Quick start](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/home#quick-start)
peguerin's avatar
peguerin committed
20
4. [Running MKBDR](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Running-MKBDR)
peguerin's avatar
peguerin committed
21
22
23
24
25
26
    * [Module validate - Check taxonomy and format validity](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Validate)
    * [Module cureGen - Curation Generation](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Curegen)
    * [Module init_ncbi_taxdump - Download NCBI taxonomy](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/init_ncbi_taxdump)
    * [Apply taxonomy curation](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Validate#basic-curation)
    * [Add new species to NCBI taxonomy](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Validate#using-a-local-ncbi-taxonomy-performs-a-curation-which-add-new-species-to-your-local-taxonomy)
4. [Output results](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Files-definition#output-files)
peguerin's avatar
peguerin committed
27
5. [How-to guide](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/How-to-guide)
peguerin's avatar
peguerin committed
28
29
30
31
6. [Reference](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/home#credits)
7. [Metabarcoding context - discussion to go further]()


peguerin's avatar
peguerin committed
32
![mkbdr](docs/mkbdr.png)
peguerin's avatar
peguerin committed
33

peguerin's avatar
peguerin committed
34

peguerin's avatar
peguerin committed
35
## Credits
peguerin's avatar
peguerin committed
36

peguerin's avatar
peguerin committed
37
**MKBDR** was coded and written by Pierre-Edouard Guerin, Laetitia Mathon and Virginie Marques.
peguerin's avatar
peguerin committed
38

peguerin's avatar
peguerin committed
39
We thank the following people for their help in the development of this software: Virginie Marques, Alice Valentini, David Mouillot, Emilie Boulanger, Laetitia Mathon, Laura Benestan, Stephanie Manel, Tony Dejean.
peguerin's avatar
peguerin committed
40

peguerin's avatar
peguerin committed
41

peguerin's avatar
peguerin committed
42

peguerin's avatar
peguerin committed
43
44
45
46
47
48
49
50
51
52
53
## Contributions and Support

:bug: If you are sure you have found a bug, please submit a bug report. You can submit your bug reports on Gitlab [here](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/issues).




For further information or help, don't hesitate to get in touch on Slack (you can join with this invite).

[![Get help on Slack](https://img.shields.io/badge/slack-cefebev%23basereference-4A154B?logo=slack)](https://cefebev.slack.com/archives/C01MDQSS57F)

peguerin's avatar
peguerin committed
54

peguerin's avatar
peguerin committed
55