annotate microsatellite_birthdeath.xml @ 1:a9d119f2cace draft default tip

planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
author devteam
date Tue, 13 Oct 2015 12:25:46 -0400
parents 6611321d8bbb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="microsatellite_birthdeath" name="Identify microsatellite births and deaths" version="1.0.0">
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description> and causal mutational mechanisms from previously identified orthologous microsatellite sets</description>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
3 <command interpreter="perl">
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
4 microsatellite_birthdeath.pl
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
5 $alignment
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
6 $orthfile
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
7 $outfile
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
8 $species
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
9 "$tree_definition"
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
10 $thresholds
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
11 $separation
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
12 $simthresh
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
13
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
14 </command>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
15 <inputs>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
16 <page>
6611321d8bbb 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"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
18
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
19 <param format="txt" name="orthfile" type="data" label="Select raw microsatellite data"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
20
6611321d8bbb 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">
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
22 <options>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
23 <filter type="data_meta" ref="alignment" key="species" />
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
24 </options>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
25 </param>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
26
1
a9d119f2cace planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
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
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
28 help="For example: ((((hg18,panTro2),ponAbe2),rheMac2),calJac1)"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
29
1
a9d119f2cace planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
30 <param name="separation" type="integer" value="40" label="Total length of flanking DNA used for sequence-similarity comparisons among species"
0
6611321d8bbb 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."/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
32
1
a9d119f2cace planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
33 <param name="thresholds" type="text" value="9,10,12,12" label="Minimum Threshold for the number of repeats for microsatellites"
0
6611321d8bbb 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."/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
35
1
a9d119f2cace planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
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
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
37 help="Enter a value from 0 to 100"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
38
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
39
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
40 </page>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
41 </inputs>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
42 <outputs>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
43 <data format="txt" name="outfile" metadata_source="orthfile"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
44 </outputs>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
45 <tests>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
46 <test>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
47 <param name="alignment" value="regVariation/microsatellite/Galaxy17_unmasked_short.maf.gz"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
48 <param name="orthfile" value="regVariation/microsatellite/Galaxy17_short_raw.txt"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
49 <param name="thresholds" value="9,10,12,12"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
50 <param name="species" value="hg18,panTro2,ponAbe2,rheMac2,calJac1"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
51 <param name="tree_definition" value="((((hg18, panTro2), ponAbe2), rheMac2), calJac1)"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
52 <param name="separation" value="10"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
53 <param name="simthresh" value="85"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
54 <output name="outfile" file="regVariation/microsatellite/Galaxy17_unmasked_results.txt"/>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
55 </test>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
56 </tests>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
57
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
58
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
59 <help>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
60
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
61 .. class:: infomark
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
62
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
63 **What it does**
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
64
6611321d8bbb 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
a9d119f2cace planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
66
0
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
67 -----
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
68
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
69 .. class:: warningmark
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
70
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
71 **Note**
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
72
6611321d8bbb 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.
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
74 The table typically reads like this:
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
75
6611321d8bbb 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
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
77
6611321d8bbb 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
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
79
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
80 Where columns list the following:
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
81
6611321d8bbb 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.
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
83
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
84 2: Start coordinate
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
85
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
86 3: End coordinate
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
87
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
88 4: Motif of microsatellite
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
89
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
90 5: Motif size
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
91
6611321d8bbb 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:
6611321d8bbb 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.
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
94
6611321d8bbb 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.
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
96
6611321d8bbb 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:
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
98 "+hg18.+panTro2 / +hg18:panTro2"
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
99
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
100 9: Actual sequences in the alignment, separated by commas.
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
101
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
102 </help>
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
103
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
104
6611321d8bbb Uploaded tool tarball.
devteam
parents:
diff changeset
105 </tool>