annotate PhyloIndex.xml @ 1:f4c8553b8dd1 draft default tip

planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit ce74877d21915627f36eae4d2eb3851a6a858aae
author ecology
date Thu, 22 May 2025 16:43:50 +0000
parents 88d3f6881490
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
1 <tool id="phylo_index" name="PhyloIndex" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.05">
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
2 <description>compute phylodiversity index based on matched phylogenetic and occupancy data</description>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
3
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
4 <macros>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
5 <token name="@TOOL_VERSION@">1.0</token>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
6 <token name="@VERSION_SUFFIX@">0</token>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
7 </macros>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
8
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
9 <requirements>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
10 <requirement type="package" version="1.0.8">r-phyloregion</requirement>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
11 <requirement type="package" version="1.6.5">r-matrix</requirement>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
12 <requirement type="package" version="5.8_1">r-ape</requirement>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
13 <requirement type="package" version="1.2.2">bioconductor-sparsearray</requirement>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
14 </requirements>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
15
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
16 <required_files>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
17 <include path="PhyloIndex.R" />
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
18 </required_files>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
19
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
20
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
21 <command detect_errors="exit_code">
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
22 <![CDATA[
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
23 Rscript '$__tool_directory__/PhyloIndex.R'
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
24 '$phylogeny'
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
25 '$occupancy'
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
26 '$random_seed'
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
27 '$model'
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
28 '$output'
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
29 ]]>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
30 </command>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
31
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
32 <inputs>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
33 <param name="phylogeny" type="data" format="newick" label="Phylogeny file (Newick format)" />
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
34 <param name="occupancy" type="data" format="tabular" label="Occupancy data (Tabular format)" />
1
f4c8553b8dd1 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit ce74877d21915627f36eae4d2eb3851a6a858aae
ecology
parents: 0
diff changeset
35 <param name="random_seed" type="integer" value="34" label="Seed for the random PD compute"/>
0
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
36 <param name="model" type="select" label="Model for the PD compute">
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
37 <option value="tipshuffle" selected="true">tipshuffle</option>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
38 <option value="rowwise">rowwise</option>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
39 <option value="colwise">colwise</option>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
40 </param>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
41 </inputs>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
42 <outputs>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
43 <data name ="output" format="tabular" label="a table" />
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
44 </outputs>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
45
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
46 <tests>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
47 <test>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
48 <param name="phylogeny" value="tree_file"/>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
49 <param name="occupancy" value="matrix_file"/>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
50 <param name="random_seed" value="34"/>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
51 <param name="model" value="tipshuffle"/>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
52 <output name="output" file="output" ftype="tabular"/>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
53 </test>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
54 </tests>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
55
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
56 <help><![CDATA[
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
57 this tool computes the phylodiversity index based on matched phylogenetic and occupancy data using the R script PhyloIndex.R.
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
58 Ensure that the input files are in the correct formats:
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
59 - Phylogeny file: Newick format
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
60 - Occupancy data: Tabular format
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
61 The output will be a tabular file containing the computed phylodiversity index.
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
62 ]]></help>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
63
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
64 <citations>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
65 <citation type="doi">10.32614/CRAN.package.phyloregion</citation>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
66 <citation type="doi">10.32614/CRAN.package.Matrix</citation>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
67 <citation type="doi">10.32614/CRAN.package.ape</citation>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
68 <citation type="doi">10.18129/B9.bioc.SparseArray</citation>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
69 </citations>
88d3f6881490 planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/Phylodiversity_workflow commit 0de557d919c26eb0b5ab61504bc597d551503ac3
ecology
parents:
diff changeset
70 </tool>