annotate VCF_to_VariantDB.xml @ 10:d5040a542e9d draft

Uploaded
author geert-vandeweyer
date Tue, 21 Oct 2014 05:11:23 -0400
parents 3b27cae9b359
children fb815517e918
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
3b27cae9b359 New Version. VariantDB checks for Genome Build matching using the Galaxy dbkey variable.
geert-vandeweyer
parents: 8
diff changeset
1 <tool id="VCF_to_DB_rev" name="VCF to VariantDB" version="0.1.3">
2
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents: 0
diff changeset
2 <description></description>
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents: 0
diff changeset
3 <expand macro="requirements" />
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents: 0
diff changeset
4 <macros>
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents: 0
diff changeset
5 <import>VCF_to_VariantDB_macros.xml</import>
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents: 0
diff changeset
6 </macros>
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
7 <command interpreter="perl">
4
7ebc71784e9f Fixed env.sh dependency
geert-vandeweyer
parents: 2
diff changeset
8 VCF_to_VariantDB.pl
8
db44ff975de8 Corrected macro.xml handling of GALAXY_URL
geert-vandeweyer
parents: 7
diff changeset
9 -H "@URL@"
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
10 -R $__root_dir__
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
11 ## input file
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
12 -v $input1
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
13 -V $__app__.security.encode_id( '%s' % $input1.id )
2
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents: 0
diff changeset
14 ## user email, for identification in DataBase
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
15 -u $__user_email__
9
3b27cae9b359 New Version. VariantDB checks for Genome Build matching using the Galaxy dbkey variable.
geert-vandeweyer
parents: 8
diff changeset
16 ## source file dbkey ( match against variantdb genome build)
3b27cae9b359 New Version. VariantDB checks for Genome Build matching using the Galaxy dbkey variable.
geert-vandeweyer
parents: 8
diff changeset
17 -G ${input1.dbkey}
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
18 ## OUTPUT FILE
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
19 -o $output1
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
20
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
21 ## SAMPLE GENDER
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
22 #if $samplegender != "undef":
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
23 -g $samplegender
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
24 #end if
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
25
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
26 ## SAMPLE NAME
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
27 #if $namefromselect.namesource == "typed" :
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
28 #if $namefromselect.typedname != "":
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
29 -n "${namefromselect.typedname}"
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
30 #end if
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
31 #elif $namefromselect.namesource == "other":
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
32 -n "${namefromselect.namefile.display_name}"
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
33 #elif $namefromselect.namesource == "vcf":
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
34 -n "${input1.display_name}"
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
35 #end if
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
36
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
37 ## DATA FILES
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
38 #if $sendData.store == "true":
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
39 -b $bamfile
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
40 -B ${bamfile.metadata.bam_index}
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
41 -c $__app__.security.encode_id( '%s' % $bamfile.id )
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
42 #end if
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
43
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
44 ## The server to send results to
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
45 -S $server
7
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
46 ## The input file format
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
47 -F $format
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
48
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
49 </command>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
50 <requirements>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
51 <requirement type="package">tabix</requirement>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
52 </requirements>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
53 <inputs>
7
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
54 <param name="input1" type="data" format="vcf" label="VCF file" help="Select variant file to import" />
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
55 <param name="format" type="select" label="VCF Source Application" help="Supported formats are VCF from UnifiedGenotyper, HaplotypeCaller, Mutect and VarScan">
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
56 <option value="UG">GATK Unified Genotyper</option>
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
57 <option value="HC">GATK Haplotype Caller</option>
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
58 <option value="MT">GATK MuTect</option>
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
59 <option value="VS">Samtools VarScan</option>
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
60 </param>
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
61 <conditional name="sendData">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
62 <param name="store" type="select" label="Store VCF and BAM Files:" help="This option allows you to send the BAM and VCF files to our storage server for dynamic loading into IGV. If you store them there, please delete them here." >
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
63 <option value="false">No</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
64 <option value="true">Yes</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
65 </param>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
66 <when value="true">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
67 <param name="bamfile" type="data" format="bam" label="BAM File." />
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
68 </when>
7
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
69 <when value="false" />
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
70 </conditional>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
71
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
72 <conditional name="namefromselect">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
73 <param name="namesource" type="select" label="Provide a Sample Name :" help="If no name is specified, a new sample will be created, and you will be notified of the name" >
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
74 <option value="typed">Type the samplename</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
75 <option value="vcf">Use the VCF File name</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
76 <option value="other">Select a file to base the name on</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
77 </param>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
78 <when value="typed">
2
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents: 0
diff changeset
79 <param name="typedname" type="text" size="25" label="Sample Name." />
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
80 </when>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
81 <when value="other">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
82 <param name="namefile" type="data" format="sam,bam,fastq,fasta,bed,fastqsanger,fastqillumina,txt,vcf" label="Select a file from the history to base the sample name upon" />
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
83 </when>
7
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
84 <when value="vcf"/>
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
85 </conditional>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
86 <param name="samplegender" type="select" label="Sample Gender: " help="This can be set from the database frontend as well.">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
87 <option value="undef">Unspecified</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
88 <option value="Male">Male</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
89 <option value="Female">Female</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
90 </param>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
91 <param name="server" type="select" label="VariantDB-Server: " help="Specify the VariantDB server you wish to send the data to. You MUST have a valid account on the target server, identical to your account here.">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
92 <option value="http://143.169.238.104/variantdb/">Main Server @ University of Antwerp</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
93 </param>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
94 </inputs>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
95 <outputs>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
96 <data format="txt" name="output1" label="${tool.name} on ${on_string}: Result"/>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
97 </outputs>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
98 <help>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
99
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
100 **What it does**
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
101
7
04e3bba317f4 Added selection to differentiate in VCF format
geert-vandeweyer
parents: 4
diff changeset
102 This tools sends VCF files with results from the GATK unified genotyper, HaploType Caller, Mutect or samtools VarScan to a VariantDB server. From there, variants can be compared between samples, filtered on various annotations etc. To add servers, specify them in the tool configuration XML file.
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
103
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
104 ------
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
105
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
106
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
107 **Input file**
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
108
2
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents: 0
diff changeset
109 VCF file from the GATK Unified Genotyper.
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
110
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
111 ------
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
112
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
113 **Outputs**
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
114
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
115 Text file with some results from the vcf-parser.
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
116
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
117 </help>
10
d5040a542e9d Uploaded
geert-vandeweyer
parents: 9
diff changeset
118 <citations>
d5040a542e9d Uploaded
geert-vandeweyer
parents: 9
diff changeset
119 <citation type="doi">10.1186/s13073-014-0074-6</citation>
d5040a542e9d Uploaded
geert-vandeweyer
parents: 9
diff changeset
120 </citations>
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
121 </tool>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
122
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
123