Skip to content

updates on README #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jflot wants to merge 3 commits into
base: master
Choose a base branch
from
Open

updates on README #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d858e1b
Update README.md
jflot Jul 20, 2020
c9c6178
Update README.md
jflot Jul 20, 2020
6605e2e
Update README.md
jflot Jul 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@
[![Build Status](https://travis-ci.org/Malfoy/BWISE.svg?branch=master)](https://travis-ci.org/Malfoy/BCOOL)


# BCOOL
# Bcool
de Bruijn graph cOrrectiOn from graph aLignment

## Dependancies
Bcool clone and compile Bcalm2 Bgreat2 Btrim and Ntcard
[Limasset A, Flot J-F, Peterlongo P (2020) Toward perfect reads: self-correction of short reads via mapping on de Bruijn graphs. Bioinformatics 36:1374–1381](https://doi.org/10.1093/bioinformatics/btz102)

It require GCC>=4.9.1, CMAKE>=3.3 and Python 3

## Dependencies
The installation script of Bcool compiles [Bcalm2](https://github.com/GATB/bcalm), [Bgreat2](https://github.com/Malfoy/BGREAT2), [Btrim](https://github.com/Malfoy/BTRIM) and [ntCard](https://github.com/bcgsc/ntCard).

This requires GCC>=4.9.1, CMAKE>=3.10, Autoconf, Automake and Python 3.

## Installation

Expand All @@ -28,7 +31,7 @@ For a faster install using 8 cores

`./test.sh`

Bcool will be tested with a fixed kmer size and with ntcard
Bcool will be tested with a fixed kmer size and with ntCard

It should output

Expand All @@ -38,7 +41,7 @@ and

`IT WORKS with ntcard!`

If only the first message is present, you can still use Bcool but you need to give a size of k to perform correction
If only the first message is present, you can still use Bcool but you need to give a size of k to perform correction.



Expand Down