README.md 3.02 KB
Newer Older
peguerin's avatar
peguerin committed
1
2
3
4
5
6
7
Only_obitools pipeline
======================

# Table of contents

1. [Introduction](#1-introduction)
2. [Installation](#2-installation)
peguerin's avatar
peguerin committed
8
9
	1. [Requirements](#21-requirements)
	2. [Optional components](#22-optional-components)
peguerin's avatar
peguerin committed
10
11
12
13
14
15
16
3. [Reporting bugs](#3-reporting-bugs)
4. [Running the pipeline](#4-running-the-pipeline)

-----------------

# 1. Introduction

peguerin's avatar
peguerin committed
17
Here, we reproduce the bioinformatics pipeline used by [SPYGEN](http://www.spygen.com/) to generate species environmental presence from raw eDNA data. This pipeline is based on [OBItools](https://git.metabarcoding.org/obitools/obitools/wikis/home) a set of python programs designed to analyse Next Generation Sequencer outputs (illumina) in the context of DNA Metabarcoding.
peguerin's avatar
peguerin committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31


# 2. Installation

You will need to install 

## 2.1. Requirements

In order to run "only_obitools", you need a couple of programs. Most of
them should be available pre-compiled for your distribution. The
programs and libraries you absolutely need are:

- [OBItools](https://pythonhosted.org/OBITools/welcome.html#installing-the-obitools)

peguerin's avatar
peguerin committed
32
- [GNU Parallel](https://www.gnu.org/software/parallel/)
peguerin's avatar
peguerin committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

## 2.2. Optional components

Other libraries are optional and only limit the features that are
built. These include:


# 3. Reporting bugs

If you're sure you've found a bug — e.g. if one of my programs crashes
with an obscur error message, or if the resulting file is missing part
of the original data, then by all means submit a bug report.

I use [GitLab's issue system](https://gitlab.com/edna/only_obitools/issues)
as my bug database. You can submit your bug reports there. Please be as
verbose as possible — e.g. include the command line, etc

# 4. Running the pipeline

peguerin's avatar
peguerin committed
52
53
* open a shell
* make a folder, name it yourself, I named it workdir
peguerin's avatar
peguerin committed
54

peguerin's avatar
peguerin committed
55
56
57
58
59
```
mkdir workdir
cd workdir
```
* clone the project and switch to the main folder, it's your working directory
peguerin's avatar
peguerin committed
60

peguerin's avatar
peguerin committed
61
62
63
64
```
git clone http://gitlab.mbb.univ-montp2.fr/edna/snakemake_only_obitools.git
cd only_obitools
```
peguerin's avatar
peguerin committed
65

peguerin's avatar
peguerin committed
66
67
68
* define 2 folders : 
    - folder which contains reference database files. You can built a reference database by following the instructions [here](projet_builtdatabase).
    - folder which contains pairend-end raw reads `.fastq.gz` files and the sample description `.dat` files. Raw reads files from the same pair must be named as `*_R1.fastq.gz` and `*_R2.fastq.gz` where wildcard `*` is the name of the sequencing run. The alphanumeric order of the names of sample description `.dat` files must be the same than the names of paired-end raw reads `.fastq.gz` files. The sample description file is a text file where each line describes one sample. Columns are separated by space or tab characters. Sample description file is described [here](https://pythonhosted.org/OBITools/scripts/ngsfilter.html).
peguerin's avatar
peguerin committed
69

peguerin's avatar
peguerin committed
70
71
72
73
74
75
76
77
78
* run the pipeline :

```
bash pipeline.sh /path/to/data /path/to/baseofreference

```
order of arguments is important : 
1. absolute path to the folder which contains paired-end raw reads files and sample description file 
2. absolute path to the folder which contains reference database files