README.md 4.38 KB
Newer Older
virginiemarques's avatar
virginiemarques committed
1
2
3
4
5
# Source code for GAPeDNA

Access it online [here](https://shiny.cefe.cnrs.fr/GAPeDNA/)\
Or scan this:

virginiemarques's avatar
virginiemarques committed
6
<img src="README/QRcode_valid.png" alt="drawing" height="150"/>
Virginie Marques's avatar
Virginie Marques committed
7

Virginie Marques's avatar
Virginie Marques committed
8
9
10
This repo presents the source code of our web-app interface GAPeDNA, investigating database gaps in eDNA metabarcoding primers.   
If you notice the link to be broken, please file an issue here.   
The most probable reason is an ungoing server maintenance, unlikely to last for more than a couple days.   
Virginie Marques's avatar
Virginie Marques committed
11

vmarques's avatar
vmarques committed
12
Alternatively, you can also access the app in your local machine from the source code as further explained.
Virginie Marques's avatar
Virginie Marques committed
13
14
15
16
17
18

## New taxa addition

To propose a new taxon to be added in GAPeDNA, please file an issue labelled 'enhancement' in this repo stating the wanted group, and provide the necessary informations:

* Primers amplifying the taxon, or a list of species amplified by each primer if you already performed the virtual PCRs
vmarques's avatar
vmarques committed
19
* One or several global spatialized checklists with relevant resolution
Virginie Marques's avatar
Virginie Marques committed
20

vmarques's avatar
vmarques committed
21
If the information is correct, the app will be updated to implement your suggestion.
virginiemarques's avatar
virginiemarques committed
22

vmarques's avatar
vmarques committed
23
24
25
26
27
28
29
## How to use GAPeDNA

GAPeDNA allows you to visualize current spatialized gaps in species coverage for a given taxonomical group within a reference database for a variety of primers.  
At the moment, the app uses EMBL release 138 (downloaded in January 2019) as the reference database and will be frequently updated.  

Here is how the data is generated:

virginiemarques's avatar
virginiemarques committed
30
![](README/schema_method2.png?raw=true "Title")
vmarques's avatar
vmarques committed
31
32
33

GAPeDNA allows you to interact with the spatialized species coverage map, while choosing the relevant primer pair and wanted spatial resolution for the species checklist.

virginiemarques's avatar
virginiemarques committed
34
![](README/schema_appli.png?raw=true "Title")
vmarques's avatar
vmarques committed
35

virginiemarques's avatar
virginiemarques committed
36
### User choices
vmarques's avatar
vmarques committed
37

vmarques's avatar
vmarques committed
38
39
40
41
42
First, you must choose the taxonomical group you want. At the moment, only marine and freshwater fishes are available.  
Then, you must choose the spatial resolution of the map. This depends on the taxon, for freshwater fishes the resolution in the drainage basins and for marine fishes, you can choose between ecoregions or provinces.
Then, you must choose which marker position you want your primer in. At the moment, you have the choice between 5 positions for fishes.  
Finally, you choose your primer of interest and the interactive map prints!

Virginie Marques's avatar
Virginie Marques committed
43
### Navigating the interface
vmarques's avatar
vmarques committed
44
45
46
47
48

You can now interact with the map. You can zoom in to find your locality in details, you can hover over areas so that the percentage of coverage is displayed simultaneously.  

You can also click on a polygon of interest and the full list of species occurring  within this polygon will be displayed on the table below. In this table, you have information on the species present but also their IUCN status and whether or not they are sequenced for your chosen marker. You can filtrate your data to print only the sequenced species for example, or display only the threatened species, or both at the same time.  

Virginie Marques's avatar
Virginie Marques committed
49
### Dowload data
vmarques's avatar
vmarques committed
50

vmarques's avatar
vmarques committed
51
52
Finally, you can download the printed table using the download button on the sidebar.

vmarques's avatar
vmarques committed
53
If you are interested in the full data to investigate the comparison in primer coverage on your own, you can install the app locally and load the full dataset in R.
vmarques's avatar
vmarques committed
54
55
56
57
58
59


## Local display of the app

You need to have R installed in your local machine.  
Please make sure the necessary packages are installed in your machine and up to date, otherwise some errors might occur.
virginiemarques's avatar
virginiemarques committed
60

virginiemarques's avatar
virginiemarques committed
61
1) Using GitHub
virginiemarques's avatar
virginiemarques committed
62

Virginie Marques's avatar
Virginie Marques committed
63
You can load the app just by calling the GitHub repo in a local R session. Depending on your internet connexion, it can take up to a few minutes to fully load.   
vmarques's avatar
vmarques committed
64
Some errors linked to package version might also arise, if such you are invited to install it on your local computer on a R session and update or install the missing packages.
virginiemarques's avatar
virginiemarques committed
65
66
67

```R
library('shiny')
Virginie Marques's avatar
Virginie Marques committed
68
runGitHub("GAPeDNA", "virginiemarques")
virginiemarques's avatar
virginiemarques committed
69
70
71
72
73
```

2) On your local computer

Alternatively, you first need to download the repo, then launch R. Here are the command to run on the terminal (Linux/Mac only):
virginiemarques's avatar
virginiemarques committed
74
75

```bash
Virginie Marques's avatar
Virginie Marques committed
76
77
git clone https://github.com/virginiemarques/GAPeDNA
cd GAPeDNA/
virginiemarques's avatar
virginiemarques committed
78
79
R
```
virginiemarques's avatar
virginiemarques committed
80
81

After, you need to load `shiny` to run the app in local inside a R session:
virginiemarques's avatar
virginiemarques committed
82
83

```R
virginiemarques's avatar
virginiemarques committed
84
library('shiny')
virginiemarques's avatar
virginiemarques committed
85
runApp()
virginiemarques's avatar
virginiemarques committed
86
```
virginiemarques's avatar
add gif    
virginiemarques committed
87
88
89

## Demonstration

vmarques's avatar
vmarques committed
90
91
Here is a GIF demonstration of how to interact with the app.

virginiemarques's avatar
add gif    
virginiemarques committed
92
![grab-landing-page](https://github.com/virginiemarques/Gaps_shiny_quicktest/blob/master/README/Shiny_2.gif)
Virginie Marques's avatar
Virginie Marques committed
93
94
95

### Credits

virginiemarques's avatar
virginiemarques committed
96
P. Lopez (UMR MARBEC) for the illustration & [C. Bernard](https://github.com/cybernar) for the online deployment on the CEFE's server.