annotate VCF_to_VariantDB.xml @ 0:156964ba18fc draft

Uploaded
author geert-vandeweyer
date Wed, 08 May 2013 04:34:06 -0400
parents
children d03a63a57e82
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
1 <tool id="VCF_to_DB_rev" name="Send VCF file to the Database" version="0.1.1">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
2 <description>Reverse processing (on VariantDB server)</description>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
3 <command interpreter="perl">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
4 VCF_to_VariantDB.pl
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
5 ## THE GALAXY HOST
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
6 -H 'http://143.169.238.104/galaxy'
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
7 -R $__root_dir__
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
8 ## input file
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
9 -v $input1
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
10 -V $__app__.security.encode_id( '%s' % $input1.id )
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
11 ## user email, for identification in VariantDB, accounts must match
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
12 -u $__user_email__
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
13
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
14 ## OUTPUT FILE
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
15 -o $output1
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
16
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
17 ## SAMPLE GENDER
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
18 #if $samplegender != "undef":
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
19 -g $samplegender
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
20 #end if
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
21
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
22 ## SAMPLE NAME
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
23 #if $namefromselect.namesource == "typed" :
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
24 #if $namefromselect.typedname != "":
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
25 -n "${namefromselect.typedname}"
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
26 #end if
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
27 #elif $namefromselect.namesource == "other":
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
28 -n "${namefromselect.namefile.display_name}"
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
29 #elif $namefromselect.namesource == "vcf":
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
30 -n "${input1.display_name}"
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
31 #end if
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
32
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
33 ## DATA FILES
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
34 #if $sendData.store == "true":
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
35 -b $bamfile
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
36 -B ${bamfile.metadata.bam_index}
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
37 -c $__app__.security.encode_id( '%s' % $bamfile.id )
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
38 #end if
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
39
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
40 ## The server to send results to
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
41 -S $server
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
42
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
43
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
44 </command>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
45 <requirements>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
46 <requirement type="package">tabix</requirement>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
47 </requirements>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
48 <inputs>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
49 <param name="input1" type="data" format="vcf" label="VCF file" help="Unified Genotyper VCF File" />
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
50 <conditional name="sendData">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
51 <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
52 <option value="false">No</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
53 <option value="true">Yes</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
54 </param>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
55 <when value="true">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
56 <param name="bamfile" type="data" format="bam" label="BAM File." />
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
57 </when>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
58 </conditional>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
59
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
60 <conditional name="namefromselect">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
61 <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
62 <option value="typed">Type the samplename</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
63 <option value="vcf">Use the VCF File name</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
64 <option value="other">Select a file to base the name on</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
65 </param>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
66 <when value="typed">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
67 <param name="typedname" type="text" size="25" label="Sample Name for Report." />
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
68 </when>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
69 <when value="other">
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
70 <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
71 </when>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
72 </conditional>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
73 <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
74 <option value="undef">Unspecified</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
75 <option value="Male">Male</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
76 <option value="Female">Female</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
77 </param>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
78 <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
79 <option value="http://143.169.238.104/variantdb/">Main Server @ University of Antwerp</option>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
80 <!-- Specify other VariantDB instances here -->
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
81 </param>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
82 </inputs>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
83 <outputs>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
84 <data format="txt" name="output1" label="${tool.name} on ${on_string}: Result"/>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
85 </outputs>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
86 <help>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
87
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
88 **What it does**
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
89
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
90 This tools sends the results from the GATK unified genotyper 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. Accounts must match between the chosen VariantDB and Galaxy user.
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
91
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
92 VariantDB is an flexible portal for filtering and annotating variants.
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
93
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
94 ------
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
95
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
96
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
97 **Input file**
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
98
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
99 VCF file from the GATK Unified Genotyper. Optional : BAM file for storage in VariantDB and subsequent visualisation in IGV.
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
100
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
101 ------
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
102
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
103 **Outputs**
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
104
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
105 Text file with some results from the vcf-parser.
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
106
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
107 </help>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
108 </tool>
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
109
156964ba18fc Uploaded
geert-vandeweyer
parents:
diff changeset
110