annotate cgatools/tools/cg_cgatools/listvariants.xml @ 13:29b29330d813 draft

Deleted selected files
author bcrain-completegenomics
date Thu, 14 Jun 2012 13:45:18 -0400
parents e183f52194a5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
1 <tool id="cga_listvariant" name="listvariants(beta)" version="0.0.1">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
2 <!--
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
3 This tool creates a GUI for cgatools listvariants from Complete Genomics, Inc.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
4 written 5-29-2012 by bcrain@completegenomics.com
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
5 -->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
6
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
7 <description>lists all called variants</description> <!--adds description in toolbar-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
8
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
9 <requirements>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
10 <requirement type="binary">cgatools</requirement>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
11 </requirements>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
12
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
13 <command> <!--run executable-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
14 cgatools listvariants
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
15 --beta
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
16 --reference ${crr.fields.path}
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
17 --output $output
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
18 #if $include_list.listing == "yes" <!--only added when yes-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
19 --variant-listing $include_list.list
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
20 #end if
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
21 $longvar
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
22 --variants
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
23 #if $file_types.data_sources.data_source == "in"
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
24 #for $v in $file_types.data_sources.varfiles <!--get each var/mastervar file-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
25 ${v.input}
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
26 #end for
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
27 #else
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
28 `cat $file_types.data_sources.varlist`
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
29 #end if
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
30 </command>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
31
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
32 <inputs>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
33 <!--form field to select crr file-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
34 <param name="crr" type="select" label="Genome build">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
35 <options from_data_table="cg_crr_files" />
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
36 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
37
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
38 <!--form field to select long variants option-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
39 <param name="longvar" type="select" label="List long variants?">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
40 <option value="" selected="true">no</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
41 <option value="--list-long-variants">yes</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
42 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
43
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
44 <!--form fields to include existing variant list-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
45 <conditional name="include_list">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
46 <param name="listing" type="select" label="Include variant listing?">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
47 <option value="no" selected="true">no</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
48 <option value="yes">yes</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
49 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
50 <when value="yes">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
51 <param name="list" type="data" format="tabular" label="Variant listing"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
52 </when>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
53 </conditional>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
54
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
55 <!--conditional to select input file type-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
56 <conditional name="file_types">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
57 <param name="file_type" type="select" label="Select the input file type">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
58 <option value="var" selected="true">var files</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
59 <option value="mastervar">mastervar files</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
60 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
61
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
62 <when value="var">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
63 <!--conditional to select variant file input-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
64 <conditional name="data_sources">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
65 <param name="data_source" type="select" label="Where are the input var files?">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
66 <option value="in" selected="true">imported into Galaxy</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
67 <option value="out">located outside Galaxy (available only for local Galaxy instances)</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
68 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
69 <when value="in">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
70 <!--form field to select variant files-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
71 <repeat name="varfiles" title="Variant files">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
72 <param name="input" type="data" format="cg_var" label="Dataset">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
73 <validator type="unspecified_build" />
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
74 <validator type="dataset_metadata_in_file" filename="cg_crr_files.loc"
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
75 metadata_name="dbkey" metadata_column="1"
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
76 message="cgatools is not currently available for this build."/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
77 <!--<validator type="expression" message="Dataset does not match selected build.">$dbkey == $crr.fields.dbkey</validator>-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
78 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
79 </repeat>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
80 </when>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
81 <when value="out">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
82 <!--form field to select crr file-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
83 <param name="varlist" type="text" label="List of variant files (/path/file)" size="200" help="file with list of var files (/path/varfile), var files can be compressed (gz, bz2)."/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
84 </when>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
85 </conditional>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
86 </when>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
87
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
88 <when value="mastervar">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
89 <!--conditional to select variant file input-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
90 <conditional name="data_sources">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
91 <param name="data_source" type="select" label="Where are the input mastervar files?">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
92 <option value="in" selected="true">imported into Galaxy</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
93 <option value="out">located outside Galaxy (available only for local Galaxy instances)</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
94 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
95 <when value="in">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
96 <!--form field to select variant files-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
97 <repeat name="varfiles" title="Variant files">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
98 <param name="input" type="data" format="cg_mastervar" label="Dataset">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
99 <validator type="unspecified_build" />
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
100 <validator type="dataset_metadata_in_file" filename="cg_crr_files.loc"
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
101 metadata_name="dbkey" metadata_column="1"
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
102 message="cgatools is not currently available for this build."/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
103 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
104 </repeat>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
105 </when>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
106 <when value="out">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
107 <!--form field to select crr file-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
108 <param name="varlist" type="text" label="List of mastervar files (/path/file)" size="200" help="file with list of mastervar files (/path/varfile), mastervar files can be compressed (gz, bz2)."/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
109 </when>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
110 </conditional>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
111 </when>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
112 </conditional>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
113 </inputs>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
114
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
115 <outputs>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
116 <data format="tabular" name="output"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
117 </outputs>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
118
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
119 <!-- <tests>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
120 <test>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
121 <param name="reference" value="hg19.crr"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
122 <param name="file_type" value="var"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
123 <param name="data_source" value="in"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
124 <param name="varfiles?input" value="??"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
125 <param name="varfiles?input" value="??"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
126 <output name="output" file="??"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
127 </test>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
128 </tests>-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
129
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
130 <help>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
131
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
132 **What it does**
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
133
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
134 This tool uses the cgatools listvariants to list all called variants present in the var or mastervar files.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
135
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
136 cgatools: http://sourceforge.net/projects/cgatools/files/
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
137
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
138 -----
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
139
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
140 **cgatools Manual**::
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
141
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
142 COMMAND NAME
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
143 listvariants - Lists the variants present in a variant file.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
144
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
145 DESCRIPTION
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
146 Lists all called variants present in the specified variant files, in a
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
147 format suitable for processing by the testvariants command. The output is a
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
148 tab-delimited file consisting of the following columns:
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
149
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
150 variantId Sequential id assigned to each variant.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
151 chromosome The chromosome of the variant.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
152 begin 0-based reference offset of the beginning of the variant.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
153 end 0-based reference offset of the end of the variant.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
154 varType The varType as extracted from the variant file.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
155 reference The reference sequence.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
156 alleleSeq The variant allele sequence as extracted from the variant
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
157 file.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
158 xRef The xRef as extrated from the variant file.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
159
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
160 OPTIONS
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
161 -h [ --help ]
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
162 Print this help message.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
163
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
164 --beta
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
165 This is a beta command. To run this command, you must pass the --beta
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
166 flag.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
167
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
168 --reference arg
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
169 The reference crr file.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
170
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
171 --output arg (=STDOUT)
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
172 The output file (may be omitted for stdout).
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
173
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
174 --variants arg
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
175 The input variant files (may be positional args).
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
176
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
177 --variant-listing arg
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
178 The output of another listvariants run, to be merged in to produce the
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
179 output of this run.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
180
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
181 --list-long-variants
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
182 In addition to listing short variants, list longer variants as well
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
183 (10's of bases) by concatenating nearby calls.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
184
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
185 SUPPORTED FORMAT_VERSION
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
186 0.3 or later
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
187 </help>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
188 </tool>