README.md 3.08 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

peguerin's avatar
peguerin committed
7
Scripts to convert FASTA files into reference database with NCBI taxonomy.
peguerin's avatar
peguerin committed
8
9
10

## Introduction

peguerin's avatar
peguerin committed
11
**MKBDR** is a python program designed to create 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
12
13
14



peguerin's avatar
peguerin committed
15
## Method
peguerin's avatar
peguerin committed
16

peguerin's avatar
peguerin committed
17
18
19
1. [Installation](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Installing-MKBDR)
2. Input Files
    * [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
20
    * [NCBI taxonomy files](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Files-definition#ncbi-taxonomies-file)
peguerin's avatar
peguerin committed
21
    * [Curation table file](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/Files-definition#curation-file)
peguerin's avatar
peguerin committed
22
3. [Quick start](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/home#quick-start)
peguerin's avatar
peguerin committed
23
24
25
26
27
28
29
4. Running MKBDR
    * [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
30
5. [How-to guide](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database/-/wikis/How-to-guide)
peguerin's avatar
peguerin committed
31
32
33
34
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
35
![mkbdr](docs/mkbdr.png)
peguerin's avatar
peguerin committed
36

peguerin's avatar
peguerin committed
37

peguerin's avatar
peguerin committed
38
## Credits
peguerin's avatar
peguerin committed
39

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

peguerin's avatar
peguerin committed
42
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
43

peguerin's avatar
peguerin committed
44

peguerin's avatar
peguerin committed
45

peguerin's avatar
peguerin committed
46
47
48
49
50
51
52
53
54
55
56
## 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
57

peguerin's avatar
peguerin committed
58