annotate cgatools_suite/tools/cgatools/testvariants.xml @ 10:50d80449f2f6 draft

Deleted selected files
author bcrain-completegenomics
date Wed, 06 Jun 2012 17:04:49 -0400
parents 96829b1b73ea
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
1 <tool id="cga_testvariants" name="testvariants(beta)" version="0.0.1">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
2 <!--
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
3 This tool creates a GUI for cgatools testvariants from Complete Genomics, Inc.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
4 written 5-29-2012 by bcrain@completegenomics.com
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
5 -->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
6
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
7 <description>test for the presence of variants</description> <!--adds description in toolbar-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
8
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
9 <requirements>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
10 <requirement type="binary">cgatools</requirement>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
11 </requirements>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
12
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
13 <command> <!--run executable-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
14 cgatools testvariants
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
15 --beta
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
16 --reference ${crr.fields.path}
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
17 --output $output
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
18 --input $listing
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
19 --variants
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
20 #if $file_types.data_sources.data_source == "in"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
21 #for $v in $file_types.data_sources.varfiles <!--get each var/mastervar file-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
22 ${v.input}
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
23 #end for
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
24 #else
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
25 `cat $file_types.data_sources.varlist`
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
26 #end if
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
27 </command>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
28
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
29 <outputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
30 <data format="tabular" name="output" />
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
31 </outputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
32
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
33 <inputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
34 <!--form field to select crr file-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
35 <param name="crr" type="select" label="Genome build">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
36 <options from_data_table="cg_crr_files" />
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
37 </param>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
38
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
39 <!--form fields to select variant list-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
40 <param name="listing" type="data" format="tabular" label="Select variant list">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
41 <validator type="unspecified_build" />
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
42 <validator type="dataset_metadata_in_file" filename="cg_crr_files.loc"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
43 metadata_name="dbkey" metadata_column="1"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
44 message="cgatools is not currently available for this build."/>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
45 </param>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
46
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
47 <!--conditional to select input file type-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
48 <conditional name="file_types">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
49 <param name="file_type" type="select" label="Select the input file type">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
50 <option value="var" selected="true">var files</option>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
51 <option value="mastervar">mastervar files</option>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
52 </param>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
53
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
54 <when value="var">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
55 <!--conditional to select variant file input-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
56 <conditional name="data_sources">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
57 <param name="data_source" type="select" label="Where are the input var files?">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
58 <option value="in" selected="true">imported into Galaxy</option>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
59 <option value="out">located outside Galaxy (available only for local Galaxy instances)</option>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
60 </param>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
61 <when value="in">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
62 <!--form field to select variant files-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
63 <repeat name="varfiles" title="Variant files">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
64 <param name="input" type="data" format="cg_var" label="Dataset">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
65 <validator type="unspecified_build" />
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
66 <validator type="dataset_metadata_in_file" filename="cg_crr_files.loc"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
67 metadata_name="dbkey" metadata_column="1"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
68 message="cgatools is not currently available for this build."/>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
69 </param>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
70 </repeat>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
71 </when>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
72 <when value="out">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
73 <!--form field to select crr file-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
74 <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)."/>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
75 </when>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
76 </conditional>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
77 </when>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
78
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
79 <when value="mastervar">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
80 <!--conditional to select variant file input-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
81 <conditional name="data_sources">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
82 <param name="data_source" type="select" label="Where are the input mastervar files?">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
83 <option value="in" selected="true">imported into Galaxy</option>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
84 <option value="out">located outside Galaxy (available only for local Galaxy instances)</option>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
85 </param>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
86 <when value="in">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
87 <!--form field to select variant files-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
88 <repeat name="varfiles" title="Variant files">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
89 <param name="input" type="data" format="cg_mastervar" label="Dataset">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
90 <validator type="unspecified_build" />
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
91 <validator type="dataset_metadata_in_file" filename="cg_crr_files.loc"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
92 metadata_name="dbkey" metadata_column="1"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
93 message="cgatools is not currently available for this build."/>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
94 </param>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
95 </repeat>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
96 </when>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
97 <when value="out">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
98 <!--form field to select crr file-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
99 <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)."/>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
100 </when>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
101 </conditional>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
102 </when>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
103 </conditional>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
104 </inputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
105
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
106 <help>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
107
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
108 **What it does**
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
109
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
110 This tool uses the cgatools testvariants to test variant or mastervar files for the presence of variants.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
111
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
112 cgatools: http://sourceforge.net/projects/cgatools/files/
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
113
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
114 -----
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
115
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
116 **cgatools Manual**::
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
117
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
118 COMMAND NAME
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
119 testvariants - Tests variant files for presence of variants.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
120
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
121 DESCRIPTION
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
122 Tests variant files for presence of variants. The output is a tab-delimited
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
123 file consisting of the columns of the input variants file, plus a column
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
124 for each assembly results file that contains a character code for each
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
125 allele. The character codes have meaning as follows:
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
126
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
127 0 This allele of this genome is consistent with the reference at this
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
128 locus but inconsistent with the variant.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
129 1 This allele of this genome has the input variant at this locus.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
130 N This allele of this genome has no-calls but is consistent with the
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
131 input variant.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
132
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
133 OPTIONS
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
134 -h [ --help ]
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
135 Print this help message.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
136
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
137 --beta
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
138 This is a beta command. To run this command, you must pass the --beta
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
139 flag.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
140
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
141 --reference arg
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
142 The reference crr file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
143
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
144 --input arg (=STDIN)
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
145 The input variants to test for.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
146
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
147 --output arg (=STDOUT)
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
148 The output file (may be omitted for stdout).
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
149
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
150 --variants arg
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
151 The input variant files (may be passed in as arguments at the end of
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
152 the command).
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
153
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
154 SUPPORTED FORMAT_VERSION
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
155 0.3 or later
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
156 </help>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
157 </tool>