annotate snpEff.xml @ 1:2c595fea585c

Add more doocumentation
author Jim Johnson <jj@umn.edu>
date Wed, 30 Jan 2013 16:20:32 -0600
parents c07c403fc470
children 3b0c657b852b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
1 <tool id="snpEff" name="SnpEff" version="3.1">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
2 <description>Variant effect and annotation</description>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
3 <!--
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
4 You will need to change the path to wherever your installation is.
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
5 You can change the amount of memory used by snpEff, just change the -Xmx parameter (e.g. use -Xmx2G for 2Gb of memory)
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
6 <command>java -Xmx6G -jar /path/to/your/snpEff/snpEff.jar eff -c /path/to/your/snpEff/snpEff/snpEff.config $inputFormat $offset -upDownStreamLen $udLength $filterIn $filterHomHet -no $filterOut -stats $statsFile $genomeVersion $input > $output </command>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
7 -->
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
8 <requirements>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
9 <requirement type="package" version="3.1">snpEff</requirement>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
10 </requirements>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
11 <command>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
12 export SNPEFF_DATA_DIR=`grep '^data_dir' \$JAVA_JAR_PATH/snpEff.config | sed 's/.*data_dir.*[=:]//'`;
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
13 if [ ! -e \$SNPEFF_DATA_DIR/$genomeVersion ] ;
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
14 then java -Xmx6G -jar \$JAVA_JAR_PATH/snpEff.jar download -c \$JAVA_JAR_PATH/snpEff.config $genomeVersion ;
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
15 fi;
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
16 java -Xmx6G -jar \$JAVA_JAR_PATH/snpEff.jar eff -c \$JAVA_JAR_PATH/snpEff.config -i $inputFormat -o $outputFormat -upDownStreamLen $udLength $filterIn $filterHomHet -no $filterOut -stats $statsFile $genomeVersion $input > $output </command>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
17 <inputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
18 <param format="vcf,tabular,pileup,bed" name="input" type="data" label="Sequence changes (SNPs, MNPs, InDels)"/>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
19
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
20 <param name="inputFormat" type="select" label="Input format">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
21 <option value="vcf">VCF</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
22 <option value="txt">Tabular</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
23 <option value="pileup">Pileup</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
24 <option value="bed">BED</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
25 </param>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
26
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
27 <param name="outputFormat" type="select" label="Output format">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
28 <option value="txt">Tabular</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
29 <option value="vcf">VCF (only if input is VCF)</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
30 <option value="bed">BED</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
31 <option value="bedAnn">BED Annotations</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
32 </param>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
33
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
34 <param name="genomeVersion" type="select" label="Genome">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
35 <options from_file="snpeffect_genomedb.loc">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
36 <column name="name" index="1"/>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
37 <column name="value" index="0"/>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
38 </options>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
39 </param>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
40
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
41 <param name="udLength" type="select" label="Upstream / Downstream length">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
42 <option value="0">No upstream / downstream intervals (0 bases)</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
43 <option value="200">200 bases</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
44 <option value="500">500 bases</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
45 <option value="1000">1000 bases</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
46 <option value="2000">2000 bases</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
47 <option value="5000" selected="true">5000 bases</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
48 <option value="10000">10000 bases</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
49 <option value="20000">20000 bases</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
50 </param>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
51
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
52 <param name="filterHomHet" type="select" display="radio" label="Filter homozygous / heterozygous changes">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
53 <option value="">No filter (analyze everything)</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
54 <option value="-hom">Analyze homozygous sequence changes only </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
55 <option value="-het">Analyze heterozygous sequence changes only </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
56 </param>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
57
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
58 <param name="filterIn" type="select" display="radio" label="Filter sequence changes">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
59 <option value="">No filter (analyze everything)</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
60 <option value="-del">Analyze deletions only </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
61 <option value="-ins">Analyze insertions only </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
62 <option value="-nmp">Only MNPs (multiple nucleotide polymorphisms) </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
63 <option value="-snp">Only SNPs (single nucleotide polymorphisms) </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
64 </param>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
65
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
66 <param name="filterOut" type="select" display="checkboxes" multiple="true" optional="false" value="None" label="Filter output">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
67 <option value="None" selected="true">None</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
68 <option value="downstream">Do not show DOWNSTREAM changes </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
69 <option value="intergenic">Do not show INTERGENIC changes </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
70 <option value="intron">Do not show INTRON changes </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
71 <option value="upstream">Do not show UPSTREAM changes </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
72 <option value="utr">Do not show 5_PRIME_UTR or 3_PRIME_UTR changes </option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
73 </param>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
74
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
75 <param name="offset" type="select" display="radio" optional="true" label="Chromosomal position">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
76 <option value="">Use default (based on input type)</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
77 <option value="-0">Force zero-based positions (both input and output)</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
78 <option value="-1">Force one-based positions (both input and output)</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
79 </param>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
80 </inputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
81 <outputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
82 <data format="tabular" name="output" >
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
83 <change_format>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
84 <when input="outputFormat" value="txt" format="tabular" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
85 <when input="outputFormat" value="vcf" format="vcf" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
86 <when input="outputFormat" value="bed" format="bed" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
87 <when input="outputFormat" value="bedAnn" format="bed" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
88 </change_format>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
89 </data>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
90 <data format="html" name="statsFile" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
91 </outputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
92 <stdio>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
93 <exit_code range=":-1" level="fatal" description="Error: Cannot open file" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
94 <exit_code range="1:" level="fatal" description="Error" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
95 </stdio>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
96 <help>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
97
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
98 This tool calculate the effect of variants (SNPs/MNPs/Insertions) and deletions.
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
99
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
100 For details about this tool, please go to http://snpEff.sourceforge.net
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
101
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
102 </help>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
103 </tool>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
104