annotate info.xml @ 0:a2a40f3bfbbd draft default tip

planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
author iuc
date Sun, 09 Nov 2025 10:56:06 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
1 <macros>
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
2 <token name="@TOOL_VERSION@">14.1</token>
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
3 <token name="@WRAPPER_VERSION@">0</token>
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
4 <xml name="help">
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
5 <help><![CDATA[
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
6 **Overview**
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
7
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
8 PAL2NAL converts a protein multiple sequence alignment plus the matching nucleotide FASTA records into a codon-aware alignment suitable for downstream Ka/Ks analyses. The script is maintained by Mikita Suyama (Kyushu University) and is distributed under GPL v2. This Galaxy wrapper surfaces the upstream `pal2nal.pl` tool so that codon alignments can be created inside workflows.
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
9
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
10 **Inputs**
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
11
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
12 * *Protein alignment (pep.aln)* — CLUSTAL or FASTA alignment of the translated sequences. Alignments may contain more than two sequences, and frame-shift events can be annotated by numeric placeholders (for example, `2` indicates a single base deletion; see the bundled `test.aln` example).
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
13 * *Nucleotide FASTA (nuc.fasta)* — Corresponding DNA or mRNA sequences. Attach one or more FASTA datasets (use *Add new Nucleotide FASTA files* for additional inputs). Sequence identifiers must match those in the protein alignment; order is detected automatically when identifiers match.
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
14
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
15 **Options**
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
16
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
17 * `-output clustal|paml|fasta|codon` (Galaxy: *Output format*).
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
18 * `-blockonly` — Restrict output to user-marked blocks (`#` rows in CLUSTAL alignments).
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
19 * `-nogap` — Remove codons containing gaps or in-frame stops.
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
20 * `-nomismatch` — Remove codons where amino acid and nucleotide sequences disagree (useful for discarding pseudogene regions).
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
21 * `-codontable` — Choose an NCBI genetic code (1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 14, 15, 16, 21, 22, 23).
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
22 * `-html` — Produce HTML formatted output (Galaxy: enable *Add HTML formatted output* to store the optional HTML view).
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
23 * `-nostderr` — Suppress STDERR warnings (for example, expected pseudogene mismatches).
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
24
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
25 **Outputs**
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
26
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
27 * Codon-respecting alignment rendered in the selected format (Galaxy labels the dataset as CLUSTAL, PAML, FASTA, HTML, or plain text as appropriate).
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
28
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
29 **Example:**
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
30
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
31 ```pal2nal.pl inputs/test.aln inputs/test.nuc -output paml -nogap > inputs/for_paml/test.codon```
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
32
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
33 **Ka/Ks calculation**
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
34
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
35 To compute Ka and Ks values, run the resulting codon alignment through PAML's `codeml`, as illustrated in the PAL2NAL distribution (`inputs/for_paml/test.cnt`, `test.tree`, `test.codeml.ori`).
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
36
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
37 **Warnings**
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
38
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
39 PAL2NAL issues messages when protein residues and underlying codons disagree (for example, pseudogene cases). These warnings are harmless unless they indicate unintended mismatches; enable *Suppress STDERR messages* to hide them.
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
40
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
41 **References and contacts**
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
42
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
43 * PAL2NAL website: http://www.bork.embl.de/pal2nal
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
44 * Support: Mikita Suyama (mikita@bioreg.kyushu-u.ac.jp)
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
45 * Example data: `inputs/test.aln`, `inputs/test.nuc`, and PAML helpers inside the `inputs/for_paml/` directory.
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
46 ]]></help>
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
47 </xml>
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
48 <xml name="citations">
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
49 <citations>
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
50 <citation type="doi">10.1093/nar/gkl315</citation>
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
51 </citations>
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
52 </xml>
a2a40f3bfbbd planemo upload for repository https://github.com/georgehe23/tools-iuc/tree/main/tools/pal2nal commit aed49bdc26e503297e1fc394ada087042dc23386
iuc
parents:
diff changeset
53 </macros>