annotate phylorelatives.xml @ 9:663fc7a8549b draft

uploaded tool xml
author boris
date Wed, 05 Jun 2013 14:05:16 -0400
parents
children 034181b4b1b8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
1 <tool id="phylorelatives" name="Phylorelatives" version="0.0.1">
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
2 <description>Relatedness of minor alelle sequences in NJ tree</description>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
3 <requirements>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
4 <requirement type="package" version="2.15.0">R</requirement>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
5 <requirement type="package" version="2.2.6">rpy2</requirement>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
6 <requirement type="package" version="3.12.0">dendropy</requirement>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
7 <requirement type="package" version="3.0-8">ape</requirement>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
8 </requirements>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
9 <command interpreter="python">phylorelatives.py
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
10 #for $sequence in $sequences:
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
11 -i "${sequence.sequence}"
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
12 #end for
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
13 -m "${multifasta}"
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
14 -b "$iterations"
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
15 $pairwise
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
16 #if str($root.root_selector)=="upload_root":
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
17 -r "${root.root_fa}"
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
18 #end if
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
19 --relatives-out "$siblings"
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
20 --newick-out "$newick"
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
21 --trees-out "$plot"
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
22
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
23 </command>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
24 <inputs>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
25 <repeat name="sequences" title="Input FASTA file" min="1" help="Files will be concatenated into a single FASTA multiple alignment file, thus equal length homologous sequences are required">
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
26 <param format="fasta" name="sequence" type="data" label="FASTA file" help="Requires at least one minor allele sequence properly labeled &quot;_minor&quot; or &quot;_test&quot; e.g. &quot;>sample1_minor&quot;">
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
27 </param>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
28 </repeat>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
29 <conditional name="root">
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
30 <param name="root_selector" type="select" label=" Root sequence">
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
31 <option value="unrooted" selected="True"></option>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
32 <option value="upload_root"></option>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
33 </param>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
34 <when value="unrooted">
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
35 </when>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
36 <when value="upload_root">
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
37 <param name="root_fa" format="fasta" type="data" label="Root tree using" help="Must have the same length as input sequences"/>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
38 </when>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
39 </conditional>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
40 <param name="pairwise" type="boolean" truevalue="-p" falsevalue="" checked="False" label="Use pairwise deletion of gaps/missing data" help="Defaults to &quot;Complete deletion&quot;"/>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
41 <param name="iterations" type="integer" value="1000" label="Change number of bootstrap replicas" help="0 to deactivate"/>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
42 </inputs>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
43 <outputs>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
44 <data format="fasta" name="multifasta" label="${tool.name} on ${on_string}: multifasta" />
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
45 <data format="tabular" name="siblings" label="${tool.name} on ${on_string}: relatives"/>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
46 <data format="txt" name="newick" label="${tool.name} on ${on_string}: newick"/>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
47 <data format="png" name="plot" label="${tool.name} on ${on_string}: plot"/>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
48 </outputs>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
49 <tests>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
50 <test>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
51 <param name="iterations" value="0"/>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
52 <param name="sequence" value="test.fa"/>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
53 <output name="siblings" file="test.fa-siblings.tab"/>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
54 </test>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
55 </tests>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
56
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
57 <help>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
58
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
59
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
60
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
61
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
62 (boris-at-bx.psu.edu)
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
63
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
64
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
65 -----
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
66
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
67 .. class:: infomark
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
68
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
69 **What it does**
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
70
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
71 Constructs relatedness of a set of sequences based on the pairwise proportion of different sites.
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
72 One or more test sequences are accepted as long as their name include the strict suffix "_minor" or "_test" (i.e. >seq1_minor).
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
73 It returns the FASTA multiple alignment used, and reports a table with the relatives of the minor allele sequence in a NJ tree, the tree plot and newick string.
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
74
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
75 -----
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
76
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
77 .. class:: warningmark
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
78
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
79 **Note**
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
80
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
81 This tools DOES NOT align the sequences.
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
82 The FASTA multiple alignment file is fabricated by concatenating same length homologous sequences.
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
83 An independently aligned FASTA multiple alignment file can be used as well.
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
84
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
85 -----
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
86
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
87 .. class:: infomark
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
88
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
89 **About formats**
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
90
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
91 **FASTA multiple alignment** --
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
92
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
93 describe format shortly
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
94
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
95 -----
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
96
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
97 **Example**
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
98
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
99 - For the following dataset::
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
100 >sample1_major
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
101 >sample1_minor
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
102 >sample2_major
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
103 >sample3_major
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
104 >sample4_major
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
105
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
106
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
107 - running this tool with **b = 1000** **m = yes** **root = RSRS**, will return::
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
108 newick
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
109 relatives
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
110 plot
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
111 </help>
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
112
663fc7a8549b uploaded tool xml
boris
parents:
diff changeset
113 </tool>