view parse_mykrobe_predict.xml @ 0:db4fe7172114 draft

"planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"

<tool id="sonneityping" name="parse mykrobe predict" version="@TOOL_VERSION@" profile="20.05">
    <description>for Shigella sonnei and tabulate results into a single tab-delimited file</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements"/>
    <command detect_errors="exit_code"><![CDATA[
        parse_mykrobe_predict --jsons

        #for $i in $json
            '$i'
        #end for

        #if $optional.alleles:
            --alleles '$optional.alleles'
        #end if

        --prefix results

    ]]></command>
    <inputs>
        <param name="json" type="data" format="json" multiple="true" optional="false" label="Mykrobe results to parse." help="Mykrobe predict results in JSON format." />

        <section name="optional" title="Optional Parameters" expanded="false">
            <param name="alleles" type="data" format="txt,tabular" optional="true" label="Alleles" help="Links each lineage name to its human-readable counterpart." />
        </section>
    </inputs>
    <outputs>
        <data format="tabular" label="parsed output" name="parsed_output" from_work_dir="results_predictResults.tsv" />
    </outputs>
    <tests>
        <test>
            <param name="json" ftype="json" value="SRR6114360.json"/>
            <param name="optional.alleles" ftype="txt" value="alleles.txt" />
            <output name="parsed_output">
                <assert_contents>
                    <has_text text="3.7.30.4" />
                    <has_text text="S. sonnei" />
                </assert_contents>
            </output>
        </test>
        <test>
            <param name="json" ftype="json" value="SRR6114360.json"/>
            <output name="parsed_output">
                <assert_contents>
                    <has_text text="3.7.30.4" />
                    <has_text text="S. sonnei" />
                </assert_contents>
            </output>
        </test>
    </tests>
    <help><![CDATA[
Parse Mykrobe Predict
=====================

Parses Mykrobe predict results for Shigella sonnei.

Mykrobe v0.9.0+ can identify input genomes as S. sonnei, assign those identified as S. sonnei to hierarchical genotypes based on detection of single nucleotide variants (SNVs; defined in the file alleles.txt), and report known mutations in the quinolone-resistance determining region (QRDR) of genes gyrA (S83L, D87G, D87Y) and parC (S80I).

Details of the genotyping scheme are available in the paper Hawkey et al, 2021, Nature Communications. Proposals for new genotype definitions to be added to the scheme can be submitted as an Issue in this repository.]]></help>
    <citations>
		<citation type="bibtex">
			@misc{GitHubsonneityping,
			title = {sonneityping},
			journal = {GitHub Repository},
			url = {https://github.com/katholt/sonneityping},
			}
		</citation>
    </citations>
</tool>