Skip to content

Commit 94b1cc1

Browse files
committed
readme upd
1 parent f272221 commit 94b1cc1

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,30 @@
22

33
## MiGEC: Molecular Identifier Guided Error Correction pipeline
44

5-
This pipeline provides several useful tools for analysis of immune repertoire sequencing data. Its main feature is the ability to use information from unique nucleotide tags (UMIs, see this [paper](http://www.nature.com/nmeth/journal/v9/n1/full/nmeth.1778.html) for details), which are attached to molecules before sequencing library preparation and allow to backtrack the original sequence of molecule. UMIs make it possible to computationally filter nearly all experimental errors from resulting immune receptor sequences.
5+
This pipeline provides several useful tools for analysis of immune repertoire sequencing data. Its main feature is the ability to use information from unique nucleotide tags (UMIs, see this [paper](http://www.nature.com/nmeth/journal/v9/n1/full/nmeth.1778.html) for details), which are attached to molecules before sequencing library preparation and allow to backtrack the original sequence of molecule. UMIs make it possible to computationally filter nearly all experimental errors from resulting immune receptor sequences.
66

77
This pipeline was designed for libraries sequenced using Illumina MiSeq and HiSeq and the main requirement for sequencing reads is that they should contain the entire CDR3 region of immune receptor gene. Sequencing libraries with high over-sequencing, i.e. ones that have 5+ reads per starting molecule (unique UMI tag), should be used for optimal error elimination.
88

99
Several modules of the pipeline, such as de-multiplexing and CDR3 extraction could be utilized for a wider range of datasets.
1010

11-
Compiled binaries are available from [here](https://github.com/mikessh/migec/releases/latest).
12-
The software is cross-platform and requires Java v1.8 to run.
11+
Compiled binaries are available from [here](https://github.com/mikessh/migec/releases/latest). You can download them and execute as
12+
13+
```bash
14+
java -jar migec.jar ...
15+
```
16+
17+
Make sure that you've specified the full/correct path to jar file. In case of Java Heap Space exception, you can increase the JVM memory limit by adding ``-Xmx20G`` (for extra 20G) after the ``-jar`` argument.
18+
19+
The software is cross-platform and requires Java v1.7+ to run.
20+
1321
Easy installation on MacOS/Linux via [Homebrew](http://brew.sh/) or [Linuxbrew](http://linuxbrew.sh/):
1422
```bash
23+
brew tap homebrew/science
1524
brew tap mikessh/repseq
1625
brew install migec
1726
migec Checkout ...
1827
```
28+
See [homebrew-repseq](https://github.com/mikessh/homebrew-repseq) for other RepSeq analysis software Homebrew installers.
1929

2030
For more details please see the [paper](http://www.nature.com/nmeth/journal/v11/n6/abs/nmeth.2960.html) describing MiGEC.
2131

@@ -43,4 +53,4 @@ Have a glance at the analyzed data (done with legacy MIGEC version):
4353

4454
* The spreadsheet demonstrating efficient error elimination for spike-in clonotypes with known sequences [[Download](https://github.com/mikessh/migec/blob/master/misc/Exp2-spikein-table.xlsx?raw=true)]
4555
* The spreadsheet with whole repertoire [[Download](https://github.com/mikessh/migec/blob/master/misc/Exp2-all-cdr-migec.xlsx?raw=true)]
46-
* An interactive network of B-cell clonal trees (created using [Cytoscape](http://cytoscape.org/)) [[Download](https://github.com/mikessh/migec/blob/master/misc/Exp2-all-cdr-migec.cys?raw=true)]
56+
* An interactive network of B-cell clonal trees (created using [Cytoscape](http://cytoscape.org/)) [[Download](https://github.com/mikessh/migec/blob/master/misc/Exp2-all-cdr-migec.cys?raw=true)]

0 commit comments

Comments
 (0)