annotate microsatellite_birthdeath.xml @ 2:da3e903b8c3e draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/microsatellite_birthdeath commit a1517c9d22029095120643bbe2c8fa53754dd2b7
author devteam
date Wed, 11 Nov 2015 12:21:05 -0500
parents d1f31a7d7c65
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="microsatellite_birthdeath" name="Identify microsatellite births and deaths" version="1.0.0">
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description> and causal mutational mechanisms from previously identified orthologous microsatellite sets</description>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
3 <command interpreter="perl">
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
4 microsatellite_birthdeath.pl
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
5 $alignment
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
6 $orthfile
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
7 $outfile
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
8 $species
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
9 "$tree_definition"
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
10 $thresholds
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
11 $separation
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
12 $simthresh
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
13
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
14 </command>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
15 <inputs>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
16 <page>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
17 <param format="maf" name="alignment" type="data" label="Select MAF alignments that have NOT been masked for nucleotide quality"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
18
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
19 <param format="txt" name="orthfile" type="data" label="Select raw microsatellite data"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
20
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
21 <param name="species" type="select" label="Select species" display="checkboxes" multiple="true" help="NOTE: Currently users are requested to select one of these three combinations: hg18-panTro2-ponAbe2, hg18-panTro2-ponAbe2-rheMac2 or hg18-panTro2-ponAbe2-rheMac2-calJac1">
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
22 <options>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
23 <filter type="data_meta" ref="alignment" key="species" />
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
24 </options>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
25 </param>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
26
2
da3e903b8c3e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/microsatellite_birthdeath commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
27 <param name="tree_definition" type="text" value= "((((hg18,panTro2),ponAbe2),rheMac2),calJac1)" label="Tree definition of all species above whether or not selected for microsatellite extraction"
0
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
28 help="For example: ((((hg18,panTro2),ponAbe2),rheMac2),calJac1)"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
29
2
da3e903b8c3e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/microsatellite_birthdeath commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
30 <param name="separation" type="integer" value="40" label="Total length of flanking DNA used for sequence-similarity comparisons among species"
0
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
31 help="A value of 40 means: 20 bp upstream and 20 bp downstream DNA will be used for similarity comparisons."/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
32
2
da3e903b8c3e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/microsatellite_birthdeath commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
33 <param name="thresholds" type="text" value="9,10,12,12" label="Minimum Threshold for the number of repeats for microsatellites"
0
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
34 help="A value of 9,10,12,12 means: All monos having fewer than 9 repeats, dis having fewer than 5 repeats, tris having fewer than 4 repeats, tetras having fewer than 3 repeats will be excluded from the output."/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
35
2
da3e903b8c3e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/microsatellite_birthdeath commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 1
diff changeset
36 <param name="simthresh" type="integer" value="80" label="Percent sequence similarity of flanking regions (of length same as the above separation distance"
0
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
37 help="Enter a value from 0 to 100"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
38
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
39
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
40 </page>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
41 </inputs>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
42 <outputs>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
43 <data format="txt" name="outfile" metadata_source="orthfile"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
44 </outputs>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
45 <tests>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
46 <test>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
47 <param name="alignment" value="regVariation/microsatellite/Galaxy17_unmasked_short.maf.gz"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
48 <param name="orthfile" value="regVariation/microsatellite/Galaxy17_short_raw.txt"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
49 <param name="thresholds" value="9,10,12,12"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
50 <param name="species" value="hg18,panTro2,ponAbe2,rheMac2,calJac1"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
51 <param name="tree_definition" value="((((hg18, panTro2), ponAbe2), rheMac2), calJac1)"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
52 <param name="separation" value="10"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
53 <param name="simthresh" value="85"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
54 <output name="outfile" file="regVariation/microsatellite/Galaxy17_unmasked_results.txt"/>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
55 </test>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
56 </tests>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
57
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
58
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
59 <help>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
60
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
61 .. class:: infomark
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
62
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
63 **What it does**
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
64
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
65 This tool uses raw orthologous microsatellite clusters (identified by the tool "Extract orthologous microsatellites") to identify microsatellite births and deaths along individual lineages of a phylogenetic tree.
1
d1f31a7d7c65 planemo upload commit 00a7926c285bc4a339bd7deebf40b28f39c7d947
devteam
parents: 0
diff changeset
66
0
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
67 -----
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
68
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
69 .. class:: warningmark
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
70
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
71 **Note**
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
72
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
73 A tab-separated output table (depending on the species being considered) is generated where each row contains all information for a microsatellite locus from multiple species.
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
74 The table typically reads like this:
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
75
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
76 hg18.chr22 16153057 16153074 A 1 ins=,imot:0:tt;dels= ,9:t>c -panTro2 hg18:tttttttttttttttttt,ponAbe2:--tttttttttttttttt,panTro2:-----ttttctttttttt
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
77
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
78 hg18.chr22 16131711 16131722 ATGC 4 NA ,2:C>T +ponAbe2 hg18:CACGCATGCATG,ponAbe2:CATGCATGCATG,panTro2:CACGCATGCATG,rheMac2:CACGCGTGCATG
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
79
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
80 Where columns list the following:
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
81
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
82 1: Chromosome/scaffold/contig of one of the species. The species chosen is the first species readable in the Newick tree submitted by the user.
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
83
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
84 2: Start coordinate
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
85
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
86 3: End coordinate
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
87
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
88 4: Motif of microsatellite
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
89
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
90 5: Motif size
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
91
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
92 6: Insertion and deletion details. Insertions are separated from deletions by a ";", and individual insertions and deletions are separated from others by a comma. For the purpose of illustration, consider the first row listed above:
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
93 "imot:0:tt", where imot/imotf again suggest insertion, the number indicates position of insertion within the microsatellite's alignment, and this is followed by identity of nucleotides that are inserted.
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
94
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
95 7: Substitution details. Individual substitutions are separated by commas. Each entry contains the position of substitution event in the microsatellites' alignment, and the nature of substitution.
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
96
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
97 8: Inference of birth/death event. Births are indicated by "+", and deaths by "-". Events such as "-hg18:panTro2" suggest death in the common ancestor of hg18 and panTro2, whereas events such as "-hg18.panTro2" indicate parallel, independent death events along the two lineages. Alternative interpretations of the event may also be listed, following a "/", such as:
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
98 "+hg18.+panTro2 / +hg18:panTro2"
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
99
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
100 9: Actual sequences in the alignment, separated by commas.
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
101
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
102 </help>
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
103
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
104
4e31fad3f08e Uploaded tool tarball.
devteam
parents:
diff changeset
105 </tool>