annotate map_chromosomes.xml @ 0:e60f92a8e1c8 draft default tip

Uploaded
author pmac
date Wed, 01 Jun 2016 03:48:29 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
1 <tool id="map_chromosomes" name="Convert between UCSC and ensembl chromosome names" version="0.0.1">
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
2 <description>chromosome representation</description>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
3 <command interpreter="perl">map_chromosomes.pl $input1 $col $delimiter ${map.fields.path} $out_file1</command>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
4 <inputs>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
5 <param format="tabular,txt" name="input1" type="data" label="this dataset"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
6 <param name="col" type="integer" value="1" label="Column containing chromosome ids"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
7 <param name="delimiter" type="select" label="Delimited by">
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
8 <option value="TAB">Tab</option>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
9 <option value="SPACE">Whitespace</option>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
10 <option value="DOT">Dot</option>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
11 <option value="COMMA">Comma</option>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
12 <option value="DASH">Dash</option>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
13 <option value="UNDERSCORE">Underscore</option>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
14 <option value="PIPE">Pipe</option>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
15 </param>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
16 <param name="map" type="select" label="Select a mapping file" help="Ensure you select the correct mapping file">
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
17 <options from_data_table="map_chromosomes">
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
18 <filter type="sort_by" column="2"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
19 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
20 </options>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
21 </param>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
22 </inputs>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
23 <outputs>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
24 <data name="out_file1" format="input" metadata_source="input1"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
25 </outputs>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
26
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
27 <tests>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
28 <test>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
29 <param name="col" value="1"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
30 <param name="delimiter" value="TAB"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
31 <param name="map" value="hg19 UCSC to ensembl"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
32 <param name="input1" value="map_chrom_ucsc.txt" dbkey="hg19" />
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
33 <output name="out_file1" file="map_chrom_ensembl.txt"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
34 </test>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
35 <test>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
36 <param name="col" value="1"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
37 <param name="delimiter" value="TAB"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
38 <param name="map" value="hg19 ensembl to UCSC"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
39 <param name="input1" value="map_chrom_ensembl.txt" dbkey="hg19" />
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
40 <output name="out_file1" file="map_chrom_ucsc.txt"/>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
41 </test>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
42 </tests>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
43 <help>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
44
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
45
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
46 **What it does**
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
47
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
48 Converts a column between the UCSC and ensembl representation of chromosomes.
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
49
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
50 .. class:: warningmark
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
51
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
52 **Warning any lines containing chromosomes that don't map or are invalid will be removed**
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
53
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
54 -----
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
55
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
56 **Example 1**
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
57
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
58 Converting this dataset::
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
59
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
60 chr21 12 123
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
61 chrM 45 345
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
62
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
63 by setting **Column** to *1*, **Delimiter** to *Tab* and **Mapping** file to *hg19 UCSC to ensembl** will produce::
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
64
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
65 21 12 123
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
66 MT 45 345
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
67
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
68 -----
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
69
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
70 **Example 2**
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
71
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
72 Converting this dataset::
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
73
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
74 21 12 123
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
75 MT 45 345
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
76
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
77 by setting **Column** to *1*, **Delimiter** to *Tab* and **Mapping** file to *hg19 ensembl to UCSC** will produce::
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
78
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
79 chr21 12 123
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
80 chrM 45 345
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
81
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
82
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
83 </help>
e60f92a8e1c8 Uploaded
pmac
parents:
diff changeset
84 </tool>