annotate tools/maf/genebed_maf_to_fasta.xml @ 2:c2a356708570

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:42 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="GeneBed_Maf_Fasta2" name="Stitch Gene blocks" version="1.0.1">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>given a set of coding exon 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 --mafSourceType=$maf_source_type.maf_source --geneBED --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 --mafSourceType=$maf_source_type.maf_source --geneBED --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 <param name="input1" type="data" format="bed" label="Gene BED File">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <validator type="unspecified_build" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <validator type="expression" message="Input must be in BED12 format.">value.metadata.columns &gt;= 12</validator> <!-- allow 12+ columns, not as strict as possible. TODO: only list bed files with 12+ columns -->
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 <validator type="dataset_ok_validator" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <options>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <filter type="data_meta" ref="input1" key="dbkey" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 </options>
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 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 <data format="fasta" name="out_file1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 <param name="input1" value="8.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 <param name="maf_source" value="cached"/>in aligning species
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 <param name="maf_identifier" value="8_WAY_MULTIZ_hg17"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 <param name="species" value="canFam1,hg17,mm5,panTro1,rn3"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 <param name="overwrite_with_gaps" value="True"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 <output name="out_file1" file="gene_bed_maf_to_fasta_out.fasta" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 <param name="input1" value="8.bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 <param name="maf_source" value="user"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 <param name="maf_file" value="4.maf"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 <param name="species" value="hg17,panTro1"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 <param name="overwrite_with_gaps" value="True"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 <output name="out_file1" file="gene_bed_maf_to_fasta_user_out.fasta" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 The coding sequence of genes are usually composed of several coding exons. Each of these coding exons is an individual genomic region, which when concatenated with each other constitutes the coding sequence. 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 gene-based intervals, in the Gene BED format. For every interval it performs the following:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 * finds all MAF blocks that overlap the coding regions;
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 * sorts MAF blocks by alignment score;
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 * stitches blocks together and resolves overlaps based on alignment score;
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 * outputs alignments in FASTA format.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 ------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 **Citation**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 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
95
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 </tool>