annotate tools/plotting/venn_list.xml @ 0:aefc86eda5f6

Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
author peterjc
date Tue, 07 Jun 2011 17:42:40 -0400
parents
children 29fcd027d67a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
1 <tool id="venn_list" name="Venn Diagram" version="0.0.3">
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
2 <description>from lists</description>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
3 <command interpreter="python">
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
4 venn_list.py
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
5 #if $universe.type_select=="implicit":
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
6 - -
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
7 #else:
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
8 $main $main.ext
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
9 #end if
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
10 "$main_lab"
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
11 #for $s in $sets:
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
12 $s.set $s.set.ext "$s.lab"
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
13 #end for
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
14 $PDF</command>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
15 <inputs>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
16 <param name="main_lab" size="30" type="text" value="Venn Diagram" label="Plot title"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
17 <conditional name="universe">
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
18 <param name="type_select" type="select" label="Implicit or explicit full ID list?">
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
19 <option value="explicit">Explicit</option>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
20 <option value="implicit">Implicit (use union of sets below)</option>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
21 </param>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
22 <when value="explicit">
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
23 <param name="main" type="data" format="tabular,fasta,fastq,sff" label="Full dataset (with all identifiers)" help="Tabular file (uses column one), FASTA, FASTQ or SFF file."/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
24 </when>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
25 <when value="implicit"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
26 </conditional>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
27 <repeat name="sets" min="1" max="3" title="Sets">
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
28 <param name="set" type="data" format="tabular,fasta,fastq,sff" label="Members of set" help="Tabular file (uses column one), FASTA, FASTQ or SFF file."/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
29 <param name="lab" size="30" type="text" value="Group" label="Caption for set"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
30 </repeat>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
31 </inputs>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
32 <outputs>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
33 <data format="pdf" name="PDF" />
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
34 </outputs>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
35 <requirements>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
36 <requirement type="python-module">rpy</requirement>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
37 <requirement type="python-module">Bio</requirement>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
38 </requirements>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
39 <tests>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
40 <!-- Doesn't seem to work properly, manages to get two sets, both
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
41 with same FASTA file, but second with default "Group" label.
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
42 <test>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
43 <param name="type_select" value="explicit"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
44 <param name="main" value="venn_list.tabular" ftype="tabular"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
45 <param name="main_lab" value="Some Proteins"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
46 <param name="set" value="rhodopsin_proteins.fasta"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
47 <param name="lab" value="Rhodopsins"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
48 <output name="PDF" file="venn_list1.pdf" ftype="pdf"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
49 </test>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
50 -->
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
51 <!-- Can't use more than one repeat value in tests (yet)
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
52 <test>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
53 <param name="type_select" value="explicit"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
54 <param name="main" value="venn_list.tabular" ftype="tabular"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
55 <param name="main_lab" value="Some Proteins"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
56 <param name="count" value="3"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
57 <param name="set" value="rhodopsin_proteins.fasta"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
58 <param name="lab" value="Rhodopsins"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
59 <param name="set" value="four_human_proteins.fasta"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
60 <param name="lab" value="Human"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
61 <param name="set" value="blastp_four_human_vs_rhodopsin.tabular"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
62 <param name="lab" value="Human vs Rhodopsin BLAST"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
63 <output name="PDF" file="venn_list3.pdf" ftype="pdf"/>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
64 </test>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
65 -->
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
66 </tests>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
67 <help>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
68
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
69 .. class:: infomark
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
70
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
71 **TIP:** If your data is in tabular files, the identifier is assumed to be in column one.
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
72
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
73 **What it does**
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
74
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
75 Draws Venn Diagram for one, two or three sets (as a PDF file).
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
76
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
77 You must supply one, two or three sets of identifiers -- corresponding
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
78 to one, two or three circles on the Venn Diagram.
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
79
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
80 In general you should also give the full list of all the identifiers
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
81 explicitly. This is used to calculate the number of identifers outside
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
82 the circles (and check the identifiers in the other files match up).
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
83 The full list can be omitted by implicitly taking the union of the
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
84 category sets. In this case, the count outside the categories (circles)
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
85 will always be zero.
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
86
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
87 The identifiers can be taken from the first column of a tabular file
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
88 (e.g. query names in BLAST tabular output, or signal peptide predictions
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
89 after filtering, etc), or from a sequence file (FASTA, FASTQ, SFF).
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
90
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
91 For example, you may have a set of NGS reads (as a FASTA, FASTQ or SFF
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
92 file), and the results of several different read mappings (e.g. to
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
93 different references) as tabular files (filtered to have just the mapped
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
94 reads). You could then show the different mappings (and their overlaps)
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
95 as a Venn Diagram, and the outside count would be the unmapped reads.
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
96
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
97 **Citations**
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
98
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
99 The Venn Diagrams are drawn using Gordon Smyth's limma package from
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
100 R/Bioconductor, http://www.bioconductor.org/
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
101
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
102 The R library is called from Python via rpy, http://rpy.sourceforge.net/
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
103
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
104 This tool uses Biopython to read SFF files. If you use this tool with
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
105 SFF files in scientific work leading to a publication, please cite the
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
106 Biopython application note:
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
107
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
108 Cock et al 2009. Biopython: freely available Python tools for computational
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
109 molecular biology and bioinformatics. Bioinformatics 25(11) 1422-3.
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
110 http://dx.doi.org/10.1093/bioinformatics/btp163 pmid:19304878.
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
111
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
112 </help>
aefc86eda5f6 Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
113 </tool>