Commit cd981eb6 authored by peguerin's avatar peguerin
Browse files

add README

parent eba8bb98
Only_obitools pipeline
======================
# Table of contents
1. [Introduction](#1-introduction)
2. [Installation](#2-installation)
1. [Requirements](#21-requirements)
2. [Optional components](#22-optional-components)
3. [Reporting bugs](#3-reporting-bugs)
4. [Running the pipeline](#4-running-the-pipeline)
-----------------
# 1. Introduction
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.
# 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)
## 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
ok
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment