Mercurial > repos > peterjc > venn_list

annotate tools/plotting/venn_list.xml @ 2:c96bef0643dc draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded v0.0.3 again to revert upload of wrong file. Sigh.
author peterjc
date Mon, 06 May 2013 14:05:13 -0400
parents baf7031d470e
children 6aae6bc0802d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
baf7031d470e 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">
baf7031d470e 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>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
3 <command interpreter="python">
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
4 venn_list.py
baf7031d470e 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":
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
6 - -
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
7 #else:
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
8 $main $main.ext
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
9 #end if
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
10 "$main_lab"
baf7031d470e 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:
baf7031d470e 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"
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
13 #end for
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
14 $PDF</command>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
15 <inputs>
baf7031d470e 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"/>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
17 <conditional name="universe">
baf7031d470e 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?">
baf7031d470e 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>
baf7031d470e 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>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
21 </param>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
22 <when value="explicit">
baf7031d470e 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."/>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
24 </when>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
25 <when value="implicit"/>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
26 </conditional>
baf7031d470e 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">
baf7031d470e 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."/>
baf7031d470e 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"/>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
30 </repeat>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
31 </inputs>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
32 <outputs>
baf7031d470e 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" />
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
34 </outputs>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
35 <requirements>
baf7031d470e 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>
baf7031d470e 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>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
38 </requirements>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
39 <tests>
baf7031d470e 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
baf7031d470e 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.
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
42 <test>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
49 </test>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
50 -->
baf7031d470e 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)
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
52 <test>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e 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"/>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
64 </test>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
65 -->
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
66 </tests>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
67 <help>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
68
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
69 .. class:: infomark
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
70
baf7031d470e 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.
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
72
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
73 **What it does**
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
74
baf7031d470e 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).
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
76
baf7031d470e 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
baf7031d470e 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.
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
79
baf7031d470e 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
baf7031d470e 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
baf7031d470e 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).
baf7031d470e 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
baf7031d470e 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)
baf7031d470e 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.
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
86
baf7031d470e 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
baf7031d470e 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
baf7031d470e 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).
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
90
baf7031d470e 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
baf7031d470e 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
baf7031d470e 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
baf7031d470e 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)
baf7031d470e 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.
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
96
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
97 **Citations**
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
98
baf7031d470e 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
baf7031d470e 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/
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
101
baf7031d470e 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/
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
103
baf7031d470e 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
baf7031d470e 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
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
106 Biopython application note:
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
107
baf7031d470e 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
baf7031d470e 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.
baf7031d470e 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.
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
111
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
112 </help>
baf7031d470e Migrated tool version 0.0.3 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
113 </tool>