annotate shm_csr.xml @ 51:8fa8836bd605 draft

Uploaded
author davidvanzessen
date Tue, 16 May 2017 08:52:48 -0400
parents 75ee66a691a0
children 3be28ac82909
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
1 <tool id="shm_csr" name="SHM &amp; CSR pipeline" version="1.0">
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
2 <description></description>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
3 <command interpreter="bash">
49
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
4 #if str ( $filter_unique.filter_unique_select ) == "remove":
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
5 wrapper.sh $in_file custom $out_file $out_file.files_path "${in_file.name}" "-" $functionality $unique $naive_output_cond.naive_output $naive_output_ca $naive_output_cg $naive_output_cm $naive_output_ce $naive_output_all $filter_unique.filter_unique_select $filter_unique.filter_unique_clone_count $class_filter_cond.class_filter $empty_region_filter $fast
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
6 #else:
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
7 wrapper.sh $in_file custom $out_file $out_file.files_path "${in_file.name}" "-" $functionality $unique $naive_output_cond.naive_output $naive_output_ca $naive_output_cg $naive_output_cm $naive_output_ce $naive_output_all $filter_unique.filter_unique_select 2 $class_filter_cond.class_filter $empty_region_filter $fast
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
8 #end if
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
9 </command>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
10 <inputs>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
11 <param name="in_file" type="data" label="IMGT zip file to be analysed" />
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
12 <param name="empty_region_filter" type="select" label="Sequence starts at" help="" >
1
faae21ba5c63 Uploaded
davidvanzessen
parents: 0
diff changeset
13 <option value="leader" selected="true">Leader: include FR1, CDR1, FR2, CDR2, FR3 in filters</option>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
14 <option value="FR1" selected="true">FR1: include CDR1,FR2,CDR2,FR3 in filters</option>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
15 <option value="CDR1">CDR1: include FR2,CDR2,FR3 in filters</option>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
16 <option value="FR2">FR2: include CDR2,FR3 in filters</option>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
17 </param>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
18 <param name="functionality" type="select" label="Functionality filter" help="" >
1
faae21ba5c63 Uploaded
davidvanzessen
parents: 0
diff changeset
19 <option value="productive" selected="true">Productive (Productive and Productive see comment)</option>
faae21ba5c63 Uploaded
davidvanzessen
parents: 0
diff changeset
20 <option value="unproductive">Unproductive (Unproductive and Unproductive see comment)</option>
faae21ba5c63 Uploaded
davidvanzessen
parents: 0
diff changeset
21 <option value="remove_unknown">Productive and Unproductive (Productive, Productive see comment, Unproductive, Unproductive and Unproductive see comment)</option>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
22 </param>
51
8fa8836bd605 Uploaded
davidvanzessen
parents: 50
diff changeset
23 <conditional name="filter_unique">
49
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
24 <param name="filter_unique_select" type="select" label="Filter unique sequences" help="See below for an example.">
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
25 <option value="remove" selected="true">Remove uniques (Based on nucleotide sequence + C)</option>
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
26 <option value="keep">Keep uniques (Based on nucleotide sequence + C)</option>
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
27 <option value="no">No</option>
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
28 </param>
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
29 <when value="remove">
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
30 <param name="filter_unique_clone_count" size="4" type="integer" label="How many sequences should be in a group to keep 1 of them" value="2" min="2"/>
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
31 </when>
f5fe63533c58 Uploaded
davidvanzessen
parents: 47
diff changeset
32 </conditional>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
33 <param name="unique" type="select" label="Remove duplicates based on" help="" >
14
59765d2c8890 Uploaded
davidvanzessen
parents: 13
diff changeset
34 <option value="VGene,CDR3.IMGT.AA,best_match_class">Top.V.Gene, CDR3 (AA), C region</option>
59765d2c8890 Uploaded
davidvanzessen
parents: 13
diff changeset
35 <option value="VGene,CDR3.IMGT.AA">Top.V.Gene, CDR3 (AA)</option>
59765d2c8890 Uploaded
davidvanzessen
parents: 13
diff changeset
36 <option value="CDR3.IMGT.AA,best_match_class">CDR3 (AA), C region</option>
59765d2c8890 Uploaded
davidvanzessen
parents: 13
diff changeset
37 <option value="CDR3.IMGT.AA">CDR3 (AA)</option>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
38
29
80c4eebf7bc9 Uploaded
davidvanzessen
parents: 28
diff changeset
39 <option value="VGene,CDR3.IMGT.seq,best_match_class">Top.V.Gene, CDR3 (nt), C region</option>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
40 <option value="VGene,CDR3.IMGT.seq">Top.V.Gene, CDR3 (nt)</option>
13
933fb21568ce Uploaded
davidvanzessen
parents: 11
diff changeset
41 <option value="CDR3.IMGT.seq,best_match_class">CDR3 (nt), C region</option>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
42 <option value="CDR3.IMGT.seq">CDR3 (nt)</option>
10
4b695ca65213 Uploaded
davidvanzessen
parents: 6
diff changeset
43 <option value="Sequence.ID" selected="true">Don't remove duplicates</option>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
44 </param>
18
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
45 <conditional name="class_filter_cond">
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
46 <param name="class_filter" type="select" label="Human Class/Subclass filter" help="" >
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
47 <option value="70_70" selected="true">>70% class and >70% subclass</option>
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
48 <option value="60_55">>60% class and >55% subclass</option>
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
49 <option value="70_0">>70% class</option>
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
50 <option value="60_0">>60% class</option>
50
75ee66a691a0 Uploaded
davidvanzessen
parents: 49
diff changeset
51 <option value="25_0">>25% class</option>
18
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
52 <option value="101_101">Do not assign (sub)class</option>
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
53 </param>
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
54 </conditional>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
55 <conditional name="naive_output_cond">
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
56 <param name="naive_output" type="select" label="Output new IMGT archives per class into your history?">
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
57 <option value="yes">Yes</option>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
58 <option value="no" selected="true">No</option>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
59 </param>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
60 </conditional>
5
012a738edf5a Uploaded
davidvanzessen
parents: 1
diff changeset
61 <param name="fast" type="select" label="Fast" help="Skips generating the new ZIP files and Change-O/Baseline" >
012a738edf5a Uploaded
davidvanzessen
parents: 1
diff changeset
62 <option value="yes">Yes</option>
012a738edf5a Uploaded
davidvanzessen
parents: 1
diff changeset
63 <option value="no" selected="true">No</option>
012a738edf5a Uploaded
davidvanzessen
parents: 1
diff changeset
64 </param>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
65 </inputs>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
66 <outputs>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
67 <data format="html" name="out_file" label = "SHM &amp; CSR on ${in_file.name}"/>
31
fe44a905aee9 Uploaded
davidvanzessen
parents: 30
diff changeset
68 <data format="imgt_archive" name="naive_output_ca" label = "Filtered IMGT IGA: ${in_file.name}" >
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
69 <filter>naive_output_cond['naive_output'] == "yes"</filter>
18
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
70 <filter>class_filter_cond['class_filter'] != "101_101"</filter>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
71 </data>
31
fe44a905aee9 Uploaded
davidvanzessen
parents: 30
diff changeset
72 <data format="imgt_archive" name="naive_output_cg" label = "Filtered IMGT IGG: ${in_file.name}" >
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
73 <filter>naive_output_cond['naive_output'] == "yes"</filter>
18
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
74 <filter>class_filter_cond['class_filter'] != "101_101"</filter>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
75 </data>
31
fe44a905aee9 Uploaded
davidvanzessen
parents: 30
diff changeset
76 <data format="imgt_archive" name="naive_output_cm" label = "Filtered IMGT IGM: ${in_file.name}" >
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
77 <filter>naive_output_cond['naive_output'] == "yes"</filter>
18
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
78 <filter>class_filter_cond['class_filter'] != "101_101"</filter>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
79 </data>
31
fe44a905aee9 Uploaded
davidvanzessen
parents: 30
diff changeset
80 <data format="imgt_archive" name="naive_output_ce" label = "Filtered IMGT IGE: ${in_file.name}" >
6
2ddb9a21f635 Uploaded
davidvanzessen
parents: 5
diff changeset
81 <filter>naive_output_cond['naive_output'] == "yes"</filter>
18
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
82 <filter>class_filter_cond['class_filter'] != "101_101"</filter>
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
83 </data>
31
fe44a905aee9 Uploaded
davidvanzessen
parents: 30
diff changeset
84 <data format="imgt_archive" name="naive_output_all" label = "Filtered IMGT all: ${in_file.name}" >
18
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
85 <filter>naive_output_cond['naive_output'] == "yes"</filter>
949a30f04d9b Uploaded
davidvanzessen
parents: 15
diff changeset
86 <filter>class_filter_cond['class_filter'] == "101_101"</filter>
6
2ddb9a21f635 Uploaded
davidvanzessen
parents: 5
diff changeset
87 </data>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
88 </outputs>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
89 <citations>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
90 <citation type="doi">10.1093/nar/gks457</citation>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
91 <citation type="doi">10.1093/bioinformatics/btv359</citation>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
92 </citations>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
93 <help>
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
94 <![CDATA[
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
95 **References**
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
96
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
97 Yaari, G. and Uduman, M. and Kleinstein, S. H. (2012). Quantifying selection in high-throughput Immunoglobulin sequencing data sets. In *Nucleic Acids Research, 40 (17), pp. e134–e134.* [`doi:10.1093/nar/gks457`_]
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
98
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
99 .. _doi:10.1093/nar/gks457: http://dx.doi.org/10.1093/nar/gks457
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
100
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
101 Gupta, Namita T. and Vander Heiden, Jason A. and Uduman, Mohamed and Gadala-Maria, Daniel and Yaari, Gur and Kleinstein, Steven H. (2015). Change-O: a toolkit for analyzing large-scale B cell immunoglobulin repertoire sequencing data: Table 1. *In Bioinformatics, 31 (20), pp. 3356–3358.* [`doi:10.1093/bioinformatics/btv359`_]
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
102
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
103 .. _doi:10.1093/bioinformatics/btv359: http://dx.doi.org/10.1093/bioinformatics/btv359
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
104
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
105 -----
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
106
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
107 **Input files**
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
108
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
109 IMGT/HighV-QUEST .zip and .txz are accepted as input files. The file to be analysed can be selected using the dropdown menu.
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
110
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
111 .. class:: infomark
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
112
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
113 Note: Files can be uploaded by using “get data” and “upload file” and selecting “IMGT archive“ as a file type. Special characters should be prevented in the file names of the uploaded samples as these can give errors when running the immune repertoire pipeline. Underscores are allowed in the file names.
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
114
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
115 -----
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
116
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
117 **Sequence starts at**
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
118
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
119 Identifies the region which will be included in the analysis (analysed region)
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
120
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
121 - Sequences which are missing a gene region (FR1/CDR1 etc) in the analysed region are excluded.
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
122 - Sequences containing an ambiguous base in the analysed region or the CDR3 are excluded.
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
123 - All other filtering/analysis is based on the analysed region.
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
124
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
125 -----
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
126
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
127 **Functionality filter**
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
128
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
129 Allows filtering on productive rearrangements, unproductive rearrangements or both based on the assignment provided by IMGT.
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
130
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
131 **Filter unique sequences**
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
132
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
133 *Remove unique:*
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
134
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
135
30
33a7c49d48a7 Uploaded
davidvanzessen
parents: 29
diff changeset
136 This filter consists of two different steps.
33a7c49d48a7 Uploaded
davidvanzessen
parents: 29
diff changeset
137
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
138 Step 1: removes all sequences of which the nucleotide sequence in the “analysed region” and the CDR3 (see sequence starts at filter) occurs only once. (Sub)classes are not taken into account in this filter step.
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
139
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
140 Step 2: removes all duplicate sequences (sequences with the exact same nucleotide sequence in the analysed region, the CDR3 and the same (sub)class).
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
141
30
33a7c49d48a7 Uploaded
davidvanzessen
parents: 29
diff changeset
142 .. class:: infomark
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
143
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
144 This means that sequences with the same nucleotide sequence but a different (sub)class will be included in the results of both (sub)classes.
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
145
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
146 *Keep unique:*
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
147
30
33a7c49d48a7 Uploaded
davidvanzessen
parents: 29
diff changeset
148 Removes all duplicate sequences (sequences with the exact same nucleotide sequence in the analysed region and the same (sub)class).
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
149
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
150 Example of the sequences that are included using either the “remove unique filter” or the “keep unique filter”
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
151
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
152 +--------------------------+
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
153 | unique filter |
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
154 +--------+--------+--------+
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
155 | values | remove | keep |
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
156 +--------+--------+--------+
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
157 | A | A | A |
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
158 +--------+--------+--------+
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
159 | A | B | B |
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
160 +--------+--------+--------+
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
161 | B | D | C |
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
162 +--------+--------+--------+
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
163 | B | | D |
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
164 +--------+--------+--------+
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
165 | C | | |
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
166 +--------+--------+--------+
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
167 | D | | |
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
168 +--------+--------+--------+
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
169 | D | | |
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
170 +--------+--------+--------+
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
171
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
172 -----
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
173
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
174 **Remove duplicates based on**
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
175
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
176 Allows the selection of a single sequence per clone. Different definitions of a clone can be chosen.
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
177
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
178 .. class:: infomark
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
179
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
180 Note: The first sequence (in the data set) of each clone is always included in the analysis. When the first matched sequence is unmatched (no subclass assigned) the first matched sequence will be included. This means that altering the data order (by for instance sorting) can change the sequence which is included in the analysis and therefore slightly influences the results.
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
181
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
182 -----
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
183
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
184 **Human Class/Subclass filter**
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
185
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
186 .. class:: warningmark
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
187
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
188 Note: This filter should only be applied when analysing human IGH data in which a (sub)class specific sequence is present. Otherwise please select the do not assign (sub)class option to prevent errors when running the pipeline.
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
189
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
190 The class percentage is based on the ‘chunk hit percentage’ (see below). The subclass percentage is based on the ‘nt hit percentage’ (see below).
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
191
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
192 The SHM & CSR pipeline identifies human Cµ, Cα, Cγ and Cε constant genes by dividing the reference sequences for the subclasses (NG_001019) in 8 nucleotide chunks which overlap by 4 nucleotides. These overlapping chunks are then individually aligned in the right order to each input sequence. This alignment is used to calculate the chunck hit percentage and the nt hit percentage.
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
193
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
194 *Chunk hit percentage*: The percentage of the chunks that is aligned
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
195
47
64711f461c8e Uploaded
davidvanzessen
parents: 39
diff changeset
196 *Nt hit percentage*: The percentage of chunks covering the subclass specific nucleotide match with the different subclasses. The most stringent filter for the subclass is 70% ‘nt hit percentage’ which means that 5 out of 7 subclass specific nucleotides for Cα or 6 out of 8 subclass specific nucleotides of Cγ should match with the specific subclass.
64711f461c8e Uploaded
davidvanzessen
parents: 39
diff changeset
197 The option “>25% class” can be chosen when you only are interested in the class (Cα/Cγ/Cµ/Cɛ) of your sequences and the length of your sequence is not long enough to assign the subclasses.
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
198
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
199 -----
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
200
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
201 **Output new IMGT archives per class into your history?**
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
202
39
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
203 If yes is selected, additional output files (one for each class) will be added to the history which contain information of the sequences that passed the selected filtering criteria. These files are in the same format as the IMGT/HighV-QUEST output files and therefore are also compatible with many other analysis programs, such as the Immune repertoire pipeline.
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
204
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
205 -----
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
206
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
207 **Execute**
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
208
a24f8c93583a Uploaded
davidvanzessen
parents: 34
diff changeset
209 Upon pressing execute a new analysis is added to your history (right side of the page). Initially this analysis will be grey, after initiating the analysis colour of the analysis in the history will change to yellow. When the analysis is finished it will turn green in the history. Now the analysis can be opened by clicking on the eye icon on the analysis of interest. When an analysis turns red an error has occurred when running the analysis. If you click on the analysis title additional information can be found on the analysis. In addition a bug icon appears. Here more information on the error can be found.
15
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
210
61d0a6318711 Uploaded
davidvanzessen
parents: 14
diff changeset
211 ]]>
0
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
212 </help>
c33d93683a09 Uploaded
davidvanzessen
parents:
diff changeset
213 </tool>