annotate hamronize_tool.xml @ 0:5fca34360c12 draft default tip

"planemo upload for repository https://github.com/quadram-institute-bioscience/galaxy-tools/tree/master/tools/hamronization commit f4357e288c6ab3d1abf0dd8a8b4ccee72cbf1924-dirty"

<tool id="hamronize_tool" name="hamronize" version="@VERSION@+galaxy0">
    <description> parse multiple Antimicrobial Resistance Analysis Reports into a common data structure</description>
    <macros>
        <import>macros.xml</import>
    </macros>

    <expand macro="requirements" />
    <expand macro="version_command" />

    <command detect_errors="exit_code"><![CDATA[
        #set $extra_2_params = str("ariba,srax,csstar,groot").split(",")
        #set $extra_1_param = $extra_2_params + str("amrfinderplus,rgi,resfinder4,deeparg,kmerresistance,srst2,amrplusplus,resfarms").split(",")
        
        hamronize 
        ${select_tool.tool}
        --analysis_software_version ${analysis_software_version}
        --reference_database_version ${reference_database_version}
        --format ${output_format}
        #if $output_format == "tsv" 
            --output hamronized.tsv
        #else
            --output hamronized.json
        #end if 
        
        #if $select_tool.tool in $extra_1_param
            --input_file_name $select_tool.input_file_name
        #end if
        
        #if $select_tool.tool in $extra_2_params
            --reference_database_id $select_tool.reference_database_id
        #end if
        
        $report
    ]]>    </command>

    <inputs>
        <param name="report" type="data" format="txt,tabular,tsv" label="Report file"/>
        <conditional name="select_tool">
            <param name="tool" type="select" label="Tool">
                <option value="abricate" selected="true">abricate</option>
                <option value="amrfinderplus">amrfinderplus</option>
                <option value="ariba">ariba</option>
                <option value="rgi">rgi</option>
                <option value="resfinder">resfinder</option>
                <option value="resfinder4">resfinder4</option>
                <option value="srax">srax</option>
                <option value="deeparg">deeparg</option>
                <option value="kmerresistance">kmerresistance</option>
                <option value="srst2">srst2</option>
                <option value="staramr">staramr</option>
                <option value="csstar">csstar</option>
                <option value="amrplusplus">amrplusplus</option>
                <option value="resfams">resfams</option>
                <option value="groot">groot</option>
            </param>
            <when value="abricate" />
            <when value="resfinder" />
            <when value="staramr" />
            <when value="amrfinderplus">
                <param name="input_file_name" type="text" label="Input file name" help="A string of sample name which the tool scanned for..."></param>
            </when>

            <when value="ariba">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
                <param name="reference_database_id" type="text" label="Reference database ID" help="String containing the reference_database_id for
                        ariba"></param>
            </when>

            <when value="rgi">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
            </when>

            <when value="resfinder4">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
            </when>

            <when value="srax">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
                <param name="reference_database_id" type="text" label="Reference database ID" help="String containing the reference_database_id for
                        srax"></param>
            </when>

            <when value="deeparg">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
            </when>

            <when value="kmerresistance">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
            </when>

            <when value="srst2">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
            </when>

            <when value="csstar">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
                <param name="reference_database_id" type="text" label="Reference database ID" help="String containing the reference_database_id for
                        csstar"></param>
            </when>

            <when value="amrplusplus">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
            </when>

            <when value="resfams">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
            </when>

            <when value="groot">
                <param name="input_file_name" type="text" label="Input file name" help="Sample name which the tool scanned for..."></param>
                <param name="reference_database_id" type="text" label="Reference database ID" help="String containing the reference_database_id for
                        grotm"></param>
            </when>
        </conditional>
        <param name="output_format" type="select" label="Output format" multiple="false" display="radio">
            <option value="tsv" selected="True">tsv</option>
            <option value="json">json</option>
        </param>
        <param name="analysis_software_version" type="text" label="Analysis software version"></param>
        <param name="reference_database_version" type="text" label="Reference database version"></param>
    </inputs>

    <outputs>
        <data format="tsv" name="output_tsv" label="${tool.name} on ${on_string}: Output" from_work_dir="hamronized.tsv">
            <filter>output_format == "tsv"</filter>
        </data>
        <data format="json" name="output_json" label="${tool.name} on ${on_string}: Output" from_work_dir="hamronized.json">
            <filter>output_format == "json"</filter>
        </data>
    </outputs>
    <tests>
        <!-- abricate -->
        <test expect_num_outputs="1">
            <param name="report" value="abricate/report.tsv" ftype="tsv" />
            <param name="tool" value="abricate" />
            <param name="output_format" value="tsv" />
            <param name="reference_database_version" value="db_v_1" />
            <param name="analysis_software_version" value="tool_v_1" />
            <output name="output_tsv" ftype="tsv" file="hamronized_abricate.tsv" />
        </test>
        <test expect_num_outputs="1">
            <param name="report" value="abricate/report.tsv" ftype="tsv" />
            <param name="tool" value="abricate" />
            <param name="output_format" value="json" />
            <param name="reference_database_version" value="db_v_1" />
            <param name="analysis_software_version" value="tool_v_1" />
            <output name="output_json" ftype="json" file="hamronized_abricate.json" />
        </test>
        <!-- ariba -->
        <test expect_num_outputs="1">
            <param name="report" value="ariba/report.tsv" ftype="tsv" />
            <param name="tool" value="ariba" />
            <param name="output_format" value="tsv" />
            <param name="reference_database_version" value="db_v_1" />
            <param name="analysis_software_version" value="ariba_v1" />
            <param name="input_file_name" value="ariba_report" />
            <param name="reference_database_id" value="dbname" />
            <output name="output_tsv" ftype="tsv" file="hamronized_ariba.tsv" />
        </test>
        <!-- rgi -->
        <test expect_num_outputs="1">
            <param name="report" value="rgi/rgi.txt" ftype="txt" />
            <param name="tool" value="rgi" />
            <param name="output_format" value="tsv" />
            <param name="reference_database_version" value="card_v1" />
            <param name="analysis_software_version" value="rgi_v1" />
            <param name="input_file_name" value="rgi_report" />
            <output name="output_tsv" ftype="tsv" file="hamronized_rgi.tsv" />
        </test>
    </tests>
    <help><![CDATA[
    Hamronize parse multiple Antimicrobial Resistance Analysis Reports into a common data structure
    ]]>    </help>
</tool>