annotate testing_cgatools-982e19c29ec0/cgatools/tools/cgatools_1.6/testvariants.xml @ 0:ef23f9cd599b draft default tip

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