annotate tools/maf/interval_maf_to_merged_fasta.xml @ 0:9071e359b9a3

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:37:19 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="Interval_Maf_Merged_Fasta2" name="Stitch MAF blocks" version="1.0.1">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>given a set of genomic intervals</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 #if $maf_source_type.maf_source == "user" #interval_maf_to_merged_fasta.py --dbkey=$dbkey --species=$maf_source_type.species --mafSource=$maf_source_type.maf_file --mafIndex=$maf_source_type.maf_file.metadata.maf_index --interval_file=$input1 --output_file=$out_file1 --chromCol=${input1.metadata.chromCol} --startCol=${input1.metadata.startCol} --endCol=${input1.metadata.endCol} --strandCol=${input1.metadata.strandCol} --mafSourceType=$maf_source_type.maf_source --mafIndexFileDir=${GALAXY_DATA_INDEX_DIR}
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 #else #interval_maf_to_merged_fasta.py --dbkey=$dbkey --species=$maf_source_type.species --mafSource=$maf_source_type.maf_identifier --interval_file=$input1 --output_file=$out_file1 --chromCol=${input1.metadata.chromCol} --startCol=${input1.metadata.startCol} --endCol=${input1.metadata.endCol} --strandCol=${input1.metadata.strandCol} --mafSourceType=$maf_source_type.maf_source --mafIndexFileDir=${GALAXY_DATA_INDEX_DIR}
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 #end if# --overwrite_with_gaps=$overwrite_with_gaps
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <page>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <param format="interval" name="input1" type="data" label="Choose intervals">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <validator type="unspecified_build" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <conditional name="maf_source_type">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <param name="maf_source" type="select" label="MAF Source">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <option value="cached" selected="true">Locally Cached Alignments</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <option value="user">Alignments in Your History</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <when value="user">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <param name="maf_file" type="data" format="maf" label="MAF File">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <options>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <filter type="data_meta" ref="input1" key="dbkey" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 </options>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <validator type="dataset_ok_validator" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <param name="species" type="select" display="checkboxes" multiple="true" label="Choose species" help="Select species to be included in the final alignment">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <options>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <filter type="data_meta" ref="maf_file" key="species" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 </options>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <when value="cached">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <param name="maf_identifier" type="select" label="MAF Type" >
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <options from_file="maf_index.loc">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <column name="name" index="0"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <column name="value" index="1"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <column name="dbkey" index="2"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 <column name="species" index="3"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 <filter type="data_meta" ref="input1" key="dbkey" column="2" multiple="True" separator=","/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 <validator type="no_options" message="No alignments are available for the build associated with the selected interval file"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 </options>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 <param name="species" type="select" display="checkboxes" multiple="true" label="Choose species" help="Select species to be included in the final alignment">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 <options from_file="maf_index.loc">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 <column name="uid" index="1"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 <column name="value" index="3"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 <column name="name" index="3"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 <filter type="param_value" ref="maf_identifier" name="uid" column="1"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 <filter type="multiple_splitter" column="3" separator=","/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 </options>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 <param name="overwrite_with_gaps" type="select" label="Split into Gapless MAF blocks" help="When set to Yes, blocks are divided around gaps appearing in any species. This will prevent gaps occurring in the interior of the sequence for an aligning species from overwriting a nucleotide found for the same position in a lower-scoring block.">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 <option value="True" selected="true">No</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 <option value="False">Yes</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 </page>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 <data format="fasta" name="out_file1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 <param name="input1" value="13.bed" dbkey="hg18" ftype="bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 <param name="maf_source" value="cached"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 <param name="maf_identifier" value="17_WAY_MULTIZ_hg18"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 <param name="species" value="hg18,mm8"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 <param name="overwrite_with_gaps" value="True"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 <output name="out_file1" file="interval_maf_to_merged_fasta_out3.fasta" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 <param name="input1" value="1.bed" dbkey="hg17" ftype="bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 <param name="maf_source" value="cached"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 <param name="maf_identifier" value="8_WAY_MULTIZ_hg17"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 <param name="species" value="canFam1,hg17,mm5,panTro1,rn3"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 <param name="overwrite_with_gaps" value="True"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 <output name="out_file1" file="interval_maf_to_merged_fasta_out.dat" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 <param name="input1" value="1.bed" dbkey="hg17" ftype="bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 <param name="maf_source" value="user"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 <param name="maf_file" value="5.maf"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 <param name="species" value="canFam1,hg17,mm5,panTro1,rn3"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 <param name="overwrite_with_gaps" value="True"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 <output name="out_file1" file="interval_maf_to_merged_fasta_user_out.dat" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 A single genomic region can be covered by multiple alignment blocks. In many cases it is desirable to stitch these alignment blocks together. This tool accepts a list of genomic intervals. For every interval it performs the following:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 * finds all MAF blocks that overlap the interval;
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 * sorts MAF blocks by alignment score;
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 * stitches blocks together and resolves overlaps based on alignment score;
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96 * outputs alignments in FASTA format.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 ------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100 **Example**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102 Here three MAF blocks overlapping a single interval are stitched together. Space between blocks 2 and 3 is filled with gaps:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104 .. image:: ./static/images/maf_icons/stitchMaf.png
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
105
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
106 ------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
107
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
108 **Citation**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
109
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
110 If you use this tool, please cite `Blankenberg D, Taylor J, Nekrutenko A; The Galaxy Team. Making whole genome multiple alignments usable for biologists. Bioinformatics. 2011 Sep 1;27(17):2426-2428. &lt;http://www.ncbi.nlm.nih.gov/pubmed/21775304&gt;`_
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
111
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
112
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
113 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
114 </tool>