annotate phylorelatives.xml @ 0:06d6e56e8c2b draft default tip

Uploaded repo.tar.gz
author boris
date Mon, 03 Feb 2014 13:01:44 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
1 <tool id="phylorelatives" name="Phylorelatives" version="0.0.1">
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
2 <description>Relatedness of minor alelle sequences in NJ tree</description>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
3 <requirements>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
4 <requirement type="package" version="2.15.0">R</requirement>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
5 <requirement type="package" version="2.2.6">rpy2</requirement>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
6 <requirement type="package" version="3.12.0">dendropy</requirement>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
7 <requirement type="package" version="3.0-8">ape</requirement>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
8 </requirements>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
9 <command interpreter="python">phylorelatives.py
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
10 #for $sequence in ( $sequences ):
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
11 -i "${sequence}"
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
12 #end for
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
13 -m "${multifasta}"
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
14 -b "$iterations"
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
15 $pairwise
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
16 $major_only
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
17 #if str($root.root_selector)=="add_root":
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
18 -r "${root.root_fa}"
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
19 #end if
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
20 --relatives-out "$siblings"
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
21 --newick-out "$newick"
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
22 --trees-out "$plot"
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
23 </command>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
24 <inputs>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
25 <param format="fasta" name="sequences" type="data" label="FASTA file" multiple="TRUE" help="Minor allele sequences must be labeled &quot;_minor&quot; or &quot;_test&quot; e.g. &quot;>sample1_minor&quot;">
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
26 </param>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
27 <conditional name="root">
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
28 <param name="root_selector" type="select" label=" Root sequence">
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
29 <option value="unrooted" selected="True"></option>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
30 <option value="add_root"></option>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
31 </param>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
32 <when value="unrooted">
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
33 </when>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
34 <when value="add_root">
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
35 <param name="root_fa" format="fasta" type="data" label="Root tree using" help="Must have the same length as input sequences"/>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
36 </when>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
37 </conditional>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
38 <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;"/>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
39 <param name="iterations" type="integer" value="1000" label="Change number of bootstrap replicas" help="0 to deactivate"/>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
40 <param name="major_only" type="boolean" truevalue="-j" falsevalue="" checked="False" label="Major-alleles-only mode" help="All sequences will be treated as major allele sequences. Useful to generate background tree"/>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
41 </inputs>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
42 <outputs>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
43 <data format="fasta" name="multifasta" label="${tool.name} on ${on_string}: multifasta used" />
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
44 <data format="tabular" name="siblings" label="${tool.name} on ${on_string}: relatives list"/>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
45 <data format="txt" name="newick" label="${tool.name} on ${on_string}: newick string"/>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
46 <data format="png" name="plot" label="${tool.name} on ${on_string}: tree plot"/>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
47 </outputs>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
48 <tests>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
49 <test>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
50 <param name="iterations" value="0"/>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
51 <param name="sequences" value="test.fa"/>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
52 <output name="siblings" file="test.fa-siblings.tab"/>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
53 </test>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
54 </tests>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
55
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
56 <help>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
57
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
58
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
59
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
60 The major and minor allele sequences of a sample are expected to cluster together in a phylogenetic tree.
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
61 Deviation from expectation suggests potential contamination coming from the closest unrelated samples.
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
62
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
63 -----
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
64
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
65 .. class:: infomark
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
66
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
67 **What it does**
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
68
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
69 Constructs relatedness of a set of sequences based on the pairwise proportion of different sites.
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
70 One or more test sequences are accepted as long as their name include the strict suffix "_minor" or "_test" (i.e. >seq1_minor).
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
71 It returns the FASTA multiple alignment used, and reports a table with the closest major allele relatives, the tree plot and newick string of the tree.
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
72
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
73 -----
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
74
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
75 .. class:: warningmark
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
76
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
77 **Note**
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
78
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
79 This tools DOES NOT align the sequences.
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
80 Consequently, same length homologous sequences are required as input to fabricate a FASTA multiple alignment by concatenation of individual FASTA files.
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
81
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
82 -----
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
83
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
84 .. class:: infomark
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
85
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
86 **About formats**
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
87
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
88 *FASTA multiple alignment*
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
89
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
90 See http://www.bioperl.org/wiki/FASTA_multiple_alignment_format
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
91
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
92 *Newick*
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
93
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
94 http://www.megasoftware.net/WebHelp/glossary/rh_newick_format.htm
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
95
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
96 -----
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
97
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
98 **Example**
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
99
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
100 - For the multiple alignment composed of the following FASTA files::
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
101
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
102 >sample1_major
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
103 >sample1_minor
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
104 >sample2_major
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
105 >sample3_major
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
106 >sample4_major
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
107
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
108
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
109 - running this tool with *root = RSRS.fasta*, and default parameters will return four datasets::
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
110
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
111 1. multiple alignment file used for running the tool
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
112 2. relatives of sample1_minor
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
113 3. NJ tree newick string (rooted on RSRS)
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
114 4. NJ tree png plot (rooted on RSRS)
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
115
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
116 -----
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
117
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
118 **Citation**
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
119
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
120 If you use this tool, please cite Dickins B, Rebolledo-Jaramillo B, et al. *In preparation.*
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
121 (boris-at-bx.psu.edu)
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
122
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
123 </help>
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
124
06d6e56e8c2b Uploaded repo.tar.gz
boris
parents:
diff changeset
125 </tool>