annotate frequency.xml @ 6:f309f1ef68f3 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ampvis2 commit cb30e4b8d695e096753fe7cb5056b118b25a87fd

<tool id="ampvis2_frequency" name="ampvis2 frequency plot" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@" license="MIT">
    <description></description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="header"/>
    <command detect_errors="exit_code"><![CDATA[
        Rscript '$rscript'
    ]]></command>
    <configfiles>
        <configfile name="rscript"><![CDATA[
            library(ampvis2, quietly = TRUE)
            data <- readRDS("$data")
            plot <- amp_frequency(
                data,
                ## https://github.com/KasperSkytte/ampvis2/issues/167
                ## #if $group_by
                ##     group_by = "$group_by",
                ## #end if
                ## tax_class = NULL,
                tax_empty = "$tax_empty",
                tax_aggregate = "$tax_aggregate",
                weight = $weight,
                normalise = $normalise,
                ## TODO
                detailed_output = FALSE
            )
            @OUTPUT_TOKEN@
        ]]></configfile>
    </configfiles>
    <inputs>
        <expand macro="rds_metadata_input_macro"/>
        <!-- https://github.com/KasperSkytte/ampvis2/issues/167
            <expand macro="metadata_select_discrete" argument="group_by" label="Group the samples by "/> -->
        <expand macro="tax_empty_macro"/>
        <expand macro="taxlevel_macro" argument="tax_aggregate" label="The taxonomic level to aggregate the OTUs">
            <option value="OTU" selected="true">OTU/ASV</option>
        </expand>
        <param argument="weight" type="boolean" truevalue="TRUE" falsevalue="FALSE" checked="true" label="Weight the frequency by abundance"/>
        <expand macro="normalise_macro" checked="true"/>
        <expand macro="out_format_macro"/>
    </inputs>
    <outputs>
        <expand macro="out_macro"/>
    </outputs>
    <tests>
        <!-- defaults -->
        <test expect_num_outputs="1">
            <param name="data" value="AalborgWWTPs.rds" ftype="ampvis2"/> 
            <output name="plot" value="AalborgWWTPs-frequency.pdf" ftype="pdf" compare="sim_size"/>
        </test>
        <!-- group_by -->
        <!-- https://github.com/KasperSkytte/ampvis2/issues/167
        <test expect_num_outputs="1">
            <param name="data" value="AalborgWWTPs.rds" ftype="ampvis2"/> 
            <param name="metadata_list" value="AalborgWWTPs-metadata.list"/> 
            <param name="group_by" value="Plant"/> 
            <output name="plot" value="AalborgWWTPs-frequency-group_by.pdf" ftype="pdf"/>
        </test> -->
    </tests>
    <help><![CDATA[
What it does
============

Generates a barplot with frequency vs read abundance.

The Galaxy tool calls the `amp_frequency
<https://kasperskytte.github.io/ampvis2/reference/amp_frequency.html>`_ function
of the ampvis2 package.

Input
=====

@HELP_RDS_INPUT@

@HELP_METADATA_LIST_INPUT@

Output
======

A frequency plot in the chosen output format.
    ]]></help>
    <expand macro="citations"/>
</tool>