annotate kplogo.xml @ 0:f6226f8823ce draft

Uploaded
author xuebing
date Thu, 23 Mar 2017 00:47:36 -0400
parents
children 3c13235a05f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
1 <tool id="kplogo" name="kpLogo" version="1.0">
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
2 <description>for positional k-mer analysis</description>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
3 <command>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
4
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
5 kpLogo $input $inputtype -o $output -alphabet $alphabet $maxk -startPos $startPos $degenerate 2> tmp;
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
6 cp ${output}.most.significant.each.position.pdf $output;
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
7 cp ${output}.pdf $logo_prob;
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
8 cp ${output}.info.pdf $logo_info;
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
9 cp ${output}.freq.pdf $logo_freq;
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
10 cp ${output}.most.significant.each.position.txt $tab_most;
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
11 cp ${output}.pass.p.cutoff.txt $tab_all;
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
12
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
13 </command>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
14 <inputs>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
15 <page>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
16 <param format="fasta" name="input" type="data" label="Fasta File" />
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
17
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
18 <param name="alphabet" type="select" label="Sequence type: DNA/RNA or Protein" >
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
19 <option value="dna" selected="True">DNA/RNA</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
20 <option value="protein">Protein</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
21 <option value="other">Other (not supported yet)</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
22 </param>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
23
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
24 <param name="inputtype" type="select" label="Weighted or Ranked" >
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
25 <option value="" selected="True">Unweighted (FASTA or Tab-delimited) </option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
26 <option value="-ranked">Ranked (FASTA or Tab-delimited)</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
27 <option value="-weighted">Weighted (Tab-delimited)</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
28 </param>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
29
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
30 <param name="maxk" type="select" label="k-mer length"
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
31 help="k-mer length">
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
32 <option value="-max_k 4" selected="True">1,2,3,4</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
33 <option value="-max_k 3">1,2,3</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
34 <option value="-max_k 2">1,2</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
35 <option value="-k 4">4</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
36 <option value="-k 3">3</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
37 <option value="-k 2">2</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
38 <option value="-k 1">1</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
39 </param>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
40
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
41 <param name="degenerate" type="select" label="Degenerate residual (DNA/RNA only)">
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
42 <option value="-gapped" selected="True">ACGTN, i.e. gapped</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
43 <option value="">None (no degenerate residuals)</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
44 <option value="-degenerate all">all IUPAC residuals: ACGTRYMKWSBDHVN</option>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
45 </param>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
46
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
47 <param name="startPos" type="integer" value="1"/>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
48
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
49
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
50 </page>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
51 </inputs>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
52 <outputs>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
53 <data format="pdf" name="logo_info" label="${tool.name} on ${on_string}: info"/>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
54 <data format="pdf" name="logo_freq" label="${tool.name} on ${on_string}: freq"/>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
55 <data format="pdf" name="logo_prob" label="${tool.name} on ${on_string}: prob"/>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
56 <data format="pdf" name="output" label="${tool.name} on ${on_string}: kmer"/>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
57 <data format="tabular" name="tab_all" label="${tool.name} on ${on_string}: all_kmer"/>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
58 <data format="tabular" name="tab_most" label="${tool.name} on ${on_string}: most_sig"/>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
59
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
60
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
61 </outputs>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
62 <help>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
63
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
64 **Note**
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
65
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
66 This tool uses Weblogo3_ in Galaxy to generate a sequence logo. The input file must be a fasta file in your current history.
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
67
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
68 It is recommended for (eg) viewing multiple sequence alignments output from the clustalw tool - set the output to fasta and feed
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
69 it in to this tool.
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
70
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
71 A typical output looks like this
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
72
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
73 .. image:: ${static_path}/images/rgWebLogo3_test.jpg
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
74
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
75 ----
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
76
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
77 **Warning about input Fasta format files**
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
78
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
79 The Weblogo3 program used by this tool will fail if your fasta sequences are not all EXACTLY the same length. The tool will provide a warning
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
80 and refuse to call the weblogo3 executable if irregular length sequences are detected.
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
81
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
82 Fasta alignments from the companion ClustalW Galaxy tool will work but many other fasta files may cause this tool to fail - please do not file
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
83 a Galaxy bug report - this is a feature of the tool and a problem with your source data - not a tool error - please make certain all your fasta
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
84 sequences are the same length!
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
85
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
86 ----
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
87
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
88 **Attribution**
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
89
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
90 Weblogo attribution and associated documentation are available at Weblogo3_
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
91
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
92 This Galaxy wrapper was written by Ross Lazarus for the rgenetics project and the source code is licensed under the LGPL_ like other rgenetics artefacts
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
93
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
94 .. _Weblogo3: http://weblogo.berkeley.edu/
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
95
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
96 .. _LGPL: http://www.gnu.org/copyleft/lesser.html
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
97
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
98 </help>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
99
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
100 </tool>
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
101
f6226f8823ce Uploaded
xuebing
parents:
diff changeset
102