annotate snpSift_filter.xml @ 1:2c595fea585c

Add more doocumentation
author Jim Johnson <jj@umn.edu>
date Wed, 30 Jan 2013 16:20:32 -0600
parents c07c403fc470
children fe23d90249ee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
1 <tool id="snpSift_filter" name="SnpSift Filter" version="3.1">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
2 <options sanitize="False" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
3 <description>Filter variants using arbitrary expressions</description>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
4 <!--
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
5 You will need to change the path to wherever your installation is.
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
6 You can change the amount of memory used, just change the -Xmx parameter (e.g. use -Xmx2G for 2Gb of memory)
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
7 java -Xmx6G -jar $JAVA_JAR_PATH/SnpSift.jar filter -f $input -e $exprFile > $output
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
8 -->
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
9 <requirements>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
10 <requirement type="package" version="3.1">snpEff</requirement>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
11 </requirements>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
12 <command>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
13 java -Xmx6G -jar \$JAVA_JAR_PATH/SnpSift.jar filter -f $input -e $exprFile > $output
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
14 </command>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
15 <inputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
16 <param format="vcf" name="input" type="data" label="VCF input"/>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
17 <param name="expr" type="text" label="Expression" size="50"/>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
18 </inputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
19 <configfiles>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
20 <configfile name="exprFile">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
21 $expr
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
22 </configfile>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
23 </configfiles>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
24
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
25 <outputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
26 <data format="vcf" name="output" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
27 </outputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
28 <stdio>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
29 <exit_code range=":-1" level="fatal" description="Error: Cannot open file" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
30 <exit_code range="1:" level="fatal" description="Error" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
31 </stdio>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
32 <help>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
33
1
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
34 **SnpSift filter**
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
35
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
36 You can filter ia vcf file using arbitrary expressions, for instance "(QUAL > 30) | (exists INDEL) | ( countHet() > 2 )". The actual expressions can be quite complex, so it allows for a lot of flexibility.
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
37
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
38 Some examples:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
39
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
40 - *I want to filter out samples with quality less than 30*:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
41
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
42 * **( QUAL &gt; 30 )**
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
43
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
44 - *...but we also want InDels that have quality 20 or more*:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
45
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
46 * **(( exists INDEL ) &amp; (QUAL >= 20)) | (QUAL >= 30 )**
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
47
1
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
48 - *...or any homozygous variant present in more than 3 samples*:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
49
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
50 * **(countHom() > 3) | (( exists INDEL ) &amp; (QUAL >= 20)) | (QUAL >= 30 )**
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
51
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
52 - *...or any heterozygous sample with coverage 25 or more*:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
53
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
54 * **((countHet() > 0) &amp;&amp; (DP >= 25)) | (countHom() > 3) | (( exists INDEL ) &amp; (QUAL >= 20)) | (QUAL >= 30 )**
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
55
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
56 - *I want to keep samples where the genotype for the first sample is homozygous variant and the genotype for the second sample is reference*:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
57
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
58 * **isHom( GEN[0] ) &amp; isVariant( GEN[0] ) &amp; isRef( GEN[1] )**
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
59
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
60
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
61 For complete details about this tool and epressions that can be used, please go to http://snpeff.sourceforge.net/SnpSift.html#filter
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
62
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
63 </help>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
64 </tool>