annotate cgatools/tools/cgatools_1.5/testvariants.xml @ 0:182426b32995 draft default tip

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