Skip to content

Commit eff8554

Browse files
mikesshmikessh
committed
Create repo
0 parents  commit eff8554

14 files changed

+3623
-0
lines changed

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2013 Mikhail Shugay
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+

‎README.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
=====================================================================
2+
MiGEC: Molecular Identifier Group-based Error Correction pipeline
3+
=====================================================================
4+
5+
This pipeline provides several useful tools for analysis of immune repertoire sequencing data. The pipeline utilizes unique nucleotide tags (UMIs) in order to filter experimental errors from resulting sequences. Those tags are attached to molecules before sequencing library preparation and allow to backtrack the original sequence of molecule. This pipeline is applicable for Illumina MiSeq and HiSeq 2500 reads. Sequencing libraries targeting CDR3 locus of immune receptor genes with high over-sequencing, i.e. ones that have at least 10 reads (optimally 30+ reads) per each starting molecule, should be used.
6+
7+
The data from 454 platform should be used with caution, as it contains homopolymer errors which (in present framework) result in reads dropped during consensus assembly. The 454 platform has a relatively low read yield, so additional read dropping could result in over-sequencing level below required threshold. If you still wish to give it a try, we would recommend filtering off all short reads and repairing indels with Coral (http://www.cs.helsinki.fi/u/lmsalmel/coral/), the latter should be run with options ```-mr 2 -mm 1000 -g 3```.
8+
9+
Features:
10+
- Flexible de-multiplexing of NGS data and extraction of UMI sequence
11+
- Assembly of consensuses of original molecules
12+
- Extraction of CDR3 regions and determination of V/J genes for human and mouse immune receptors (TRA/TRB/TRG/TRD and IGH/IGL/IGK)
13+
- Additional filtering of hot-spot errors
14+
15+
To run the steps of the pipeline either download the scripts and install Java + Groovy and run as (e.g. for the first step of pipeline, "Checkout")
16+
17+
>$groovy Checkout.groovy
18+
19+
or simply download a standalone jar and execute
20+
21+
>$java -cp migec-v1.0.2.jar Checkout
22+
23+
24+
STANDARD PIPELINE
25+
=================
26+
27+
1. Checkout
28+
==============================
29+
Description: A script to perform de-multiplexing and UMI tag extraction
30+
31+
Standard usage:
32+
>$java -cp migec-v1.0.2.jar Checkout -cu barcodes.txt R1.fastq.gz R2.fastq.gz ./checkout/
33+
34+
For unpaired library:
35+
>$java -cp migec-v1.0.2.jar Checkout -cu barcodes.txt R.fastq.gz - ./checkout/
36+
37+
barcodes.txt format is the following,
38+
>SAMPLE-ID (tab) MASTER-ADAPTER-SEQUENCE (tab) SLAVE-ADAPTER-SEQUENCE
39+
40+
A sequencing read is scanned for master adapter and then, if found, its mate is scanned for slave adapter. R2.fastq.gz and slave adapter sequence could be omitted.
41+
Adaptor sequnce is accepted with any IUPAC DNA letters. Upper and lower case letters mark seed and fuzzy-search region parts respectively. 'N' characters mark UMI region to be extracted.
42+
E.g.
43+
>S1 (tab) acgtacgtAAGGTTcadkgagNNNNNN
44+
45+
will search for AAGGTT seed exact match, then for the remaining adapter sequence with two mismatches allowed and output the NNNNNN region to header.
46+
47+
Additional parameters:
48+
49+
```-o``` could speed up if reads are oriented (i.e. master adapter should be in R1).
50+
51+
```-r``` will apply a custom RC mask. By default it assumes Illumina reads with mates on different strands, so it reverse-complements read with slave adapter so that output reads will be on master strand.
52+
53+
```--rc-barcodes``` also searches for both adapter sequences in reverse complement. Use it if unsure of your library structure.
54+
55+
56+
57+
58+
2. Histogram
59+
==============================
60+
Description: A script to generate over-sequencing statistics
61+
62+
Standard usage:
63+
>$java -cp migec-v1.0.2.jar Histogram ./checkout/checkout.filelist.txt ./checkout/histogram
64+
65+
Will generate several files, the one important for basic data processing is ./checkout/histogram.overseq.txt. The header contains MIG sizes, while each row for a sample is the number of reads in MIGs of a given size. Plot of MIG size (log coordinates) vs number of reads in MIG should display a clear peak. This plot should be used to set a MIG size cutoff in Assemble.
66+
67+
68+
69+
70+
3. Assemble
71+
==============================
72+
Description: A script to perform UMI-guided assembly
73+
74+
Standard usage:
75+
76+
>$java -cp migec-v1.0.2.jar Assemble -c ./checkout/S1_R1.fastq.gz ./checkout/S1_R2.fastq.gz ./assembly/S1 ./assembly/assembly.log
77+
78+
For unpaired library:
79+
80+
>$java -cp migec-v1.0.2.jar Assemble -c ./checkout/S1_R1.fastq - ./assembly/S1 ./assembly/assembly.log
81+
82+
83+
All reads are grouped by their UMI and then read groups (aka molecular identifier groups, MIGs) with >10 reads (default value, see Histogram.groovy for details on setting it) are assembled. Multiple alignment is performed and consensus sequence is generated.
84+
85+
By default both only ./assembly/S1_R2.fastq.gz is assembled. To assemble both reads, use ```-m``` option, execute
86+
>$groovy Assemble -c -m 1:1 ./checkout/S1_R2.fastq.gz ./checkout/S1_R2.fastq.gz ./assembly/S1
87+
88+
In case of library with overlapping reads, the script can try to overlap them prior to assembly to generate a single output:
89+
>$groovy Assemble -c -m 0:0 ./checkout/S1_R2.fastq.gz ./checkout/S1_R2.fastq.gz ./assembly/S1
90+
91+
which will generate ./assembly/S1_RO.fastq.gz, containing assembly results _only_ for overlapping reads.
92+
93+
The ```--min-count``` option sets minimum number of reads in MIG.
94+
95+
96+
97+
98+
4. CdrBlast
99+
===============================
100+
Description: A script to extract CDR3 sequences
101+
102+
Standard usage (assuming library contains T-cell Receptor Alpha Chain sequences)
103+
104+
For assembled data:
105+
106+
>$java -cp migec-v1.0.2.jar CdrBlast -a -C TRA ./assembly/S1_R2.fastq.gz ./cdr3blast/S1_asm.cdr3blast.txt
107+
108+
For raw data:
109+
110+
>$java -cp migec-v1.0.2.jar CdrBlast -C TRA ./checkout/S1_R2.fastq.gz ./cdr3blast/S1_raw.cdr3blast.txt
111+
112+
113+
NOTE:
114+
115+
1) NCBI-BLAST+ package required
116+
117+
2) Both raw and assembled data should be processed to apply the last step of filtration.
118+
119+
120+
121+
122+
5. FilterCdrBlastResults
123+
============================================
124+
Description: A script to filter erroneous CDR3 sequences produced due to hot-spot PCR and NGS errors
125+
126+
Standard usage:
127+
128+
>$java -cp migec-v1.0.2.jar FilterCdrBlastResults -s ./cdr3blast/S1_asm.cdr3blast.txt ./cdr3blast/S1_raw.cdr3blast.txt ./final/S1.cdr3blast.txt
129+
130+
The ```-s``` option tells to filter CDR3s represented by single MIGs, as for deep profiling (with our protocol) they could be associated with reverse transcription errors and experimental artifacts. Now the file S1.cdr3blast.txt contains a filtered CDR3/V/J clonotype table. Note that translated CDR3 sequences are obtained by simultaneously translating codons in two directions: from V and J segments to the middle of CDR3. If a frameshift is detected, the incomplete codon is added in lower case, with missing nucleotides marked as "?"; stop codons are marked by "*". CDR3 that contain either frameshift or stop codon are non-functional and could be filtered using ```-n``` option. You could additionally build a graph of hypermutations for the sample using
131+
132+
>$java -cp migec-v1.0.2.jar CreateCdrHypermGraph ./final/S1.cdr3blast.txt ./net
133+
134+
which will generate files that allow fast network construction using Cytoscape's network from table and import table routines.

0 commit comments

Comments
 (0)