annotate otu_network.xml @ 4:0eb71454597d draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ampvis2 commit e0ad9ce8f508215ec6af69be2682a0faf38415da
author iuc
date Mon, 10 Nov 2025 12:58:55 +0000
parents 3ceafc03b9a0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
1 <tool id="ampvis2_otu_network" name="ampvis2 OTU network plot" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@" license="MIT">
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
2 <description></description>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
3 <macros>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
4 <import>macros.xml</import>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
5 </macros>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
6 <expand macro="header"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
8 Rscript '$rscript'
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
9 ]]></command>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
10 <configfiles>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
11 <configfile name="rscript"><![CDATA[
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
12 library(ampvis2, quietly = TRUE)
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
13 #if $tax_add
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
14 #set ta='c("' + '", "'.join(str($tax_add).split(",")) + '")'
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
15 #else
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
16 #set ta='NULL'
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
17 #end if
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
18 data <- readRDS("$data")
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
19 plot <- amp_otu_network(
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
20 data,
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
21 min_abundance = $min_abundance,
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
22 #if $color_by
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
23 color_by = "$color_by",
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
24 #end if
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
25 tax_aggregate = "$tax_aggregate",
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
26 tax_add = $ta,
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
27 @TAX_SHOW@
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
28 tax_class = NULL,
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
29 tax_empty = "$tax_empty",
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
30 normalise = $normalise,
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
31 )
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
32 @OUTPUT_TOKEN@
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
33 ]]></configfile>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
34 </configfiles>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
35 <inputs>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
36 <expand macro="rds_metadata_input_macro"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
37 <param argument="min_abundance" type="float" value="0" min="0" label="Minimum taxa abundance" help="per sample"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
38 <expand macro="metadata_select" argument="color_by" label="Color the samples by"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
39 <expand macro="taxlevel_macro" argument="tax_aggregate" label="The taxonomic level to aggregate the OTUs">
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
40 <option value="Phylum" selected="true">Phylum</option>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
41 </expand>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
42 <expand macro="taxlevel_macro" argument="tax_add" multiple="true" optional="true" label="Additional taxonomic level(s) to display"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
43 <expand macro="tax_show_macro" value="10"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
44 <expand macro="tax_empty_macro"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
45 <expand macro="normalise_macro" checked="true"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
46 <expand macro="out_format_macro"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
47 </inputs>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
48 <outputs>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
49 <expand macro="out_macro"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
50 </outputs>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
51 <tests>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
52 <!-- defaults -->
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
53 <test expect_num_outputs="1">
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
54 <param name="data" value="AalborgWWTPs.rds" ftype="ampvis2"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
55 <output name="plot" value="AalborgWWTPs-otu_network.pdf" ftype="pdf" compare="sim_size"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
56 </test>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
57 <!-- defaults color -->
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
58 <test expect_num_outputs="1">
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
59 <param name="data" value="AalborgWWTPs.rds" ftype="ampvis2"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
60 <param name="metadata_list" value="AalborgWWTPs-metadata.list"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
61 <param name="color_by" value="Plant"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
62 <output name="plot" value="AalborgWWTPs-otu_network-color_by.pdf" ftype="pdf" compare="sim_size"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
63 </test>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
64 </tests>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
65 <help><![CDATA[
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
66 What it does
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
67 ============
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
68
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
69 Generates network plot of taxa and samples.
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
70
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
71 The Galaxy tool calls the `amp_otu_network
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
72 <https://kasperskytte.github.io/ampvis2/reference/amp_otu_network.html>`_ function
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
73 of the ampvis2 package (based on ggnet2.).
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
74
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
75 Input
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
76 =====
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
77
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
78 @HELP_RDS_INPUT@
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
79
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
80 @HELP_METADATA_LIST_INPUT@
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
81
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
82 Output
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
83 ======
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
84
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
85 An OTU network plot in the chosen output format.
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
86 ]]></help>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
87 <expand macro="citations"/>
3ceafc03b9a0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
88 </tool>