annotate listvariants.xml @ 1:fec197eb2f00 draft

Uploaded
author bcrain-completegenomics
date Thu, 24 May 2012 15:15:21 -0400
parents 8caa26b33983
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
1 <tool id="cga_listvariant" name="listvariants" version="0.0.1">
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
2
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
3 <description>lists all called variants</description> <!--adds description in toolbar-->
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
4
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
5 <command> <!--run executable-->
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
6 cgatools listvariants
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
7 --beta
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
8 --reference ${crr.fields.path}
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
9 --output $output
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
10 --variants
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
11 #for $v in $varfiles <!--get each var file-->
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
12 ${v.input}
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
13 #end for
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
14 #if $include_list.listing == "yes" <!--only added when yes-->
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
15 --variant-listing $include_list.list
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
16 #end if
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
17 $longvar
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
18 </command>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
19
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
20 <inputs>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
21 <!--form field to select crr file-->
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
22 <param name="crr" type="select" label="Genome build">
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
23 <options from_data_table="cgatools" />
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
24 </param>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
25
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
26 <!--form field to select long variants option-->
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
27 <param name="longvar" type="select" label="List long variants?">
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
28 <option value="" selected="true">no</option>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
29 <option value="--list-long-variants">yes</option>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
30 </param>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
31
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
32 <!--form fields to include existing variant list-->
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
33 <conditional name="include_list">
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
34 <param name="listing" type="select" label="Include variant listing?">
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
35 <option value="no" selected="true">no</option>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
36 <option value="yes">yes</option>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
37 </param>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
38 <when value="yes">
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
39 <param name="list" type="data" format="tabular" label="Variant listing"/>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
40 </when>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
41 </conditional>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
42
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
43 <!--form field to select all variant files-->
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
44 <repeat name="varfiles" title="Var file">
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
45 <param name="input" type="data" format="tabular" label="Dataset">
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
46 <validator type="unspecified_build" />
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
47 <validator type="dataset_metadata_in_file" filename="cgatools.loc"
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
48 metadata_name="dbkey" metadata_column="0"
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
49 message="cgatools is not currently available for this build."/>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
50 </param>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
51 </repeat>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
52 </inputs>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
53
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
54 <outputs>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
55 <data format="tabular" name="output" />
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
56 </outputs>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
57
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
58 <help>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
59
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
60 **What it does**
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
61
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
62 This tool uses the cgatools listvariants to list all called variants present in the var or mastervar files.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
63
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
64 cgatools: http://sourceforge.net/projects/cgatools/files/
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
65
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
66 -----
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
67
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
68 **cgatools Manual**::
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
69
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
70 COMMAND NAME
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
71 listvariants - Lists the variants present in a variant file.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
72
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
73 DESCRIPTION
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
74 Lists all called variants present in the specified variant files, in a
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
75 format suitable for processing by the testvariants command. The output is a
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
76 tab-delimited file consisting of the following columns:
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
77
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
78 variantId Sequential id assigned to each variant.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
79 chromosome The chromosome of the variant.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
80 begin 0-based reference offset of the beginning of the variant.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
81 end 0-based reference offset of the end of the variant.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
82 varType The varType as extracted from the variant file.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
83 reference The reference sequence.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
84 alleleSeq The variant allele sequence as extracted from the variant
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
85 file.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
86 xRef The xRef as extrated from the variant file.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
87
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
88 OPTIONS
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
89 -h [ --help ]
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
90 Print this help message.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
91
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
92 --beta
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
93 This is a beta command. To run this command, you must pass the --beta
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
94 flag.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
95
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
96 --reference arg
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
97 The reference crr file.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
98
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
99 --output arg (=STDOUT)
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
100 The output file (may be omitted for stdout).
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
101
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
102 --variants arg
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
103 The input variant files (may be positional args).
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
104
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
105 --variant-listing arg
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
106 The output of another listvariants run, to be merged in to produce the
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
107 output of this run.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
108
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
109 --list-long-variants
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
110 In addition to listing short variants, list longer variants as well
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
111 (10's of bases) by concatenating nearby calls.
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
112
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
113
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
114
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
115 SUPPORTED FORMAT_VERSION
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
116 0.3 or later
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
117 </help>
8caa26b33983 Uploaded
bcrain-completegenomics
parents:
diff changeset
118 </tool>