annotate frequency.xml @ 4:a6c27a3c7814 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:53:06 +0000
parents 602c13b29eb5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
1 <tool id="ampvis2_frequency" name="ampvis2 frequency plot" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@" license="MIT">
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
2 <description></description>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
3 <macros>
602c13b29eb5 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>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
5 </macros>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
6 <expand macro="header"/>
602c13b29eb5 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[
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
8 Rscript '$rscript'
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
9 ]]></command>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
10 <configfiles>
602c13b29eb5 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[
602c13b29eb5 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)
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
13 data <- readRDS("$data")
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
14 plot <- amp_frequency(
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
15 data,
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
16 ## https://github.com/KasperSkytte/ampvis2/issues/167
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
17 ## #if $group_by
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
18 ## group_by = "$group_by",
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
19 ## #end if
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
20 ## tax_class = NULL,
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
21 tax_empty = "$tax_empty",
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
22 tax_aggregate = "$tax_aggregate",
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
23 weight = $weight,
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
24 normalise = $normalise,
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
25 ## TODO
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
26 detailed_output = FALSE
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
27 )
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
28 @OUTPUT_TOKEN@
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
29 ]]></configfile>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
30 </configfiles>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
31 <inputs>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
32 <expand macro="rds_metadata_input_macro"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
33 <!-- https://github.com/KasperSkytte/ampvis2/issues/167
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
34 <expand macro="metadata_select_discrete" argument="group_by" label="Group the samples by "/> -->
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
35 <expand macro="tax_empty_macro"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
36 <expand macro="taxlevel_macro" argument="tax_aggregate" label="The taxonomic level to aggregate the OTUs">
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
37 <option value="OTU" selected="true">OTU/ASV</option>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
38 </expand>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
39 <param argument="weight" type="boolean" truevalue="TRUE" falsevalue="FALSE" checked="true" label="Weight the frequency by abundance"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
40 <expand macro="normalise_macro" checked="true"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
41 <expand macro="out_format_macro"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
42 </inputs>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
43 <outputs>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
44 <expand macro="out_macro"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
45 </outputs>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
46 <tests>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
47 <!-- defaults -->
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
48 <test expect_num_outputs="1">
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
49 <param name="data" value="AalborgWWTPs.rds" ftype="ampvis2"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
50 <output name="plot" value="AalborgWWTPs-frequency.pdf" ftype="pdf" compare="sim_size"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
51 </test>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
52 <!-- group_by -->
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
53 <!-- https://github.com/KasperSkytte/ampvis2/issues/167
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
54 <test expect_num_outputs="1">
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
55 <param name="data" value="AalborgWWTPs.rds" ftype="ampvis2"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
56 <param name="metadata_list" value="AalborgWWTPs-metadata.list"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
57 <param name="group_by" value="Plant"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
58 <output name="plot" value="AalborgWWTPs-frequency-group_by.pdf" ftype="pdf"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
59 </test> -->
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
60 </tests>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
61 <help><![CDATA[
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
62 What it does
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
63 ============
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
64
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
65 Generates a barplot with frequency vs read abundance.
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
66
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
67 The Galaxy tool calls the `amp_frequency
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
68 <https://kasperskytte.github.io/ampvis2/reference/amp_frequency.html>`_ function
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
69 of the ampvis2 package.
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
70
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
71 Input
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
72 =====
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
73
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
74 @HELP_RDS_INPUT@
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
75
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
76 @HELP_METADATA_LIST_INPUT@
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
77
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
78 Output
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
79 ======
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
80
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
81 A frequency plot in the chosen output format.
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
82 ]]></help>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
83 <expand macro="citations"/>
602c13b29eb5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit 9ed0c3078be166bd22136771f517ae91a5198ecf
iuc
parents:
diff changeset
84 </tool>