Mercurial > repos > saskia-hiltemann > cgatools_v17

annotate tools/cgatools17/listvariants_v17.xml @ 1:3a2e0f376f26 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Minor change to tv2vcf.xml to allow for workflow automation
author dgdekoning
date Wed, 21 Oct 2015 10:09:15 -0400
parents
children 64017ce705b6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
1 <tool id="cg_listvariant" name="ListVariants" version="1.7.1">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
2
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
3 <description>Lists all variants present in CG var or masterVar file</description>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
4
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
5 <requirements>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
6 <requirement type="package" version="1">cgatools17</requirement>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
7 </requirements>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
8
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
9 <command> <!--run executable-->
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
10 echo \$PATH;
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
11 cgatools | head -1;
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
12 cgatools listvariants
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
13 --beta
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
14 --reference ${crr.fields.crr_path}
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
15 --output $output
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
16 #if $include_list.listing == "yes" <!--only added when yes-->
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
17 --variant-listing $include_list.list
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
18 #end if
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
19 $longvar
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
20 --variants
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
21 #for $v in $file_types.varfiles <!--get each var/mastervar file-->
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
22 ${v.input}
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
23 #end for
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
24
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
25
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
26 </command>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
27
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
28 <inputs>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
29 <!--form field to select crr file-->
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
30 <param name="crr" type="select" label="Reference genome (.crr file)">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
31 <options from_data_table="cg_anno_files" />
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
32 </param>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
33
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
34 <conditional name="file_types">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
35 <param name="file_type" type="select" label="Select the input file type">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
36 <option value="var" selected="true">var files</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
37 <option value="mastervar">mastervar files</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
38 </param>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
39 <when value="var">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
40 <repeat name="varfiles" title="Variant files" min="1">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
41 <param name="input" type="data" format="cg_var" label="Dataset"/>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
42 </repeat>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
43 </when>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
44 <when value="mastervar">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
45 <repeat name="varfiles" title="Variant files" min="1">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
46 <param name="input" type="data" format="cg_mastervar" label="Dataset"/>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
47 </repeat>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
48 </when>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
49 </conditional>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
50
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
51 <param name="longvar" type="select" label="List long variants?">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
52 <option value="" selected="true">no</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
53 <option value="--list-long-variants">yes</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
54 </param>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
55
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
56 <conditional name="include_list">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
57 <param name="listing" type="select" label="Include variant listing?">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
58 <option value="no" selected="true">no</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
59 <option value="yes">yes</option>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
60 </param>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
61 <when value="yes">
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
62 <param name="list" type="data" format="tabular" label="Variant listing"/>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
63 </when>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
64 </conditional>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
65 <param name="fname" type="text" value="" label="Prefix for your output file" help="Optional"/>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
66 </inputs>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
67
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
68 <outputs>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
69 <data format="tabular" name="output" label="$fname ${tool.name} on ${on_string}"/>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
70 </outputs>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
71
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
72 <help>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
73 **What it does**
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
74
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
75 This tool uses the cgatools listvariants to list all called variants present in the var or mastervar files.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
76
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
77 **cgatools 1.7.1 Documentation**
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
78
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
79 Userguide: http://cgatools.sourceforge.net/docs/1.7.1/cgatools-user-guide.pdf
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
80
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
81 Release notes: http://cgatools.sourceforge.net/docs/1.7.1/cgatools-release-notes.pdf
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
82
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
83 **Command line reference**::
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
84
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
85 COMMAND NAME
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
86 listvariants - Lists the variants present in a variant file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
87
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
88 DESCRIPTION
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
89 Lists all called variants present in the specified variant files, in a
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
90 format suitable for processing by the testvariants command. The output is a
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
91 tab-delimited file consisting of the following columns:
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
92
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
93 variantId Sequential id assigned to each variant.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
94 chromosome The chromosome of the variant.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
95 begin 0-based reference offset of the beginning of the variant.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
96 end 0-based reference offset of the end of the variant.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
97 varType The varType as extracted from the variant file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
98 reference The reference sequence.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
99 alleleSeq The variant allele sequence as extracted from the variant
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
100 file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
101 xRef The xRef as extrated from the variant file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
102
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
103 OPTIONS
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
104 -h [ --help ]
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
105 Print this help message.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
106
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
107 --beta
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
108 This is a beta command. To run this command, you must pass the --beta
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
109 flag.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
110
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
111 --reference arg
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
112 The reference crr file.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
113
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
114 --output arg (=STDOUT)
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
115 The output file (may be omitted for stdout).
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
116
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
117 --variants arg
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
118 The input variant files (may be positional args).
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
119
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
120 --variant-listing arg
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
121 The output of another listvariants run, to be merged in to produce the
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
122 output of this run.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
123
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
124 --list-long-variants
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
125 In addition to listing short variants, list longer variants as well
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
126 (10's of bases) by concatenating nearby calls.
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
127
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
128 SUPPORTED FORMAT_VERSION
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
129 0.3 or later
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
130 </help>
3a2e0f376f26 Minor change to tv2vcf.xml to allow for workflow automation
dgdekoning
parents:
diff changeset
131 </tool>