annotate filter-abund.xml @ 8:97f65399e30d draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/khmer commit 14ea2dc5ef36219c908ed64b256794711ce7b902"

<tool id="khmer_filter_abundance" name="khmer: Filter reads" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
    <description>
        by minimal k-mer abundance
    </description>
    <macros>
        <token name="@BINARY@">filter-abund.py</token>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements" />
    <expand macro="stdio" />
    <expand macro="version" />
    <command><![CDATA[
set -u &&
@LINK_SEQUENCES@
mkdir output && cd output &&
@BINARY@
--cutoff=${cutoff}
${variable_coverage}
@THREADS@
${input_countgraph_filename}
@USE_SEQUENCES@
]]>
    </command>
    <inputs>
        <expand macro="input_sequences_filenames" />
        <param argument="--variable_coverage" name="variable_coverage" type="boolean" checked="false" truevalue="--variable-coverage" falsevalue=""
            label="Variable coverage"
            help="Only trim when a sequence has high enough coverage; median abundance > 20" />
        <param argument="--cutoff" name="cutoff" type="integer" value="2" label="Cutoff"
            help="Trim at k-mers below this abundance" />
        <expand macro="input_countgraph_filename" />
    </inputs>
    <outputs>
        <expand macro="output_sequences" extension="abundfilt"/>
    </outputs>
    <tests>
        <test>
            <param name="inputs" value="test-abund-read-2.fa" />
            <param name="input_countgraph_filename"
                value="test-abund-read-2.oxlicg" ftype="oxlicg" />
            <output_collection name="sequences" type="list">
                <element name="test-abund-read-2.fa">
                    <assert_contents>
                        <has_text text="GGTTGACGGGGCTCAGGG" />
                    </assert_contents>
                </element>
            </output_collection>
        </test>
        <test>
            <param name="inputs" value="test-abund-read-2.fa" />
            <param name="input_countgraph_filename"
                value="test-abund-read-2.oxlicg" ftype="oxlicg" />
            <param name="cutoff" value="1" />
            <output_collection name="sequences" type="list">
                <element name="test-abund-read-2.fa">
                    <assert_contents>
                        <has_text text="GGTTGACGGGGCTCAGGG" />
                    </assert_contents>
                </element>
            </output_collection>
        </test>
    </tests>
    <help><![CDATA[
Trims fastq/fasta sequences at k-mers of a given abundance based on a provided k-mer countgraph

If the input sequences are from RNAseq or metagenome sequencing then
`--variable-coverage` should be used.

@HELP_FOOTER@
]]>
    </help>
    <citations>
        <expand macro="software-citation" />
        <expand macro="counting-citation" />
    </citations>
</tool>