annotate mykrobe_parser.xml @ 7:12b397ad8687 draft default tip

planemo upload for repository https://github.com/phac-nml/mykrobe-parser commit 97945a3ad655f1a0f99f577d0d423124460d900a

<tool id="mykrobe_parseR" name="mykrobe_parseR" version="@VERSION@+galaxy2" profile="16.04">
    <macros>
        <token name="@VERSION@">0.1.4.1</token>
    </macros>
    <requirements>
        <requirement type="package" version="3.4.1">r-base</requirement>
        <requirement type="package" version="1.5.0">r-jsonlite</requirement>
        <requirement type="package" version="0.1.0">r-here</requirement>
        <requirement type="package" version="0.7.6">r-dplyr</requirement>
        <requirement type="package" version="0.2.5">r-purrr</requirement>
        <requirement type="package" version="0.8.1">r-tidyr</requirement>
        <requirement type="package" version="1.6.0">r-optparse</requirement>
	<requirement type="package" version="1.3.0">r-stringr</requirement>
    </requirements>
    <command detect_errors="exit_code"><![CDATA[

	mkdir collection_files &&

        #for $file in $input
            ln -s "$file" collection_files/"$file.element_identifier".json &&
        #end for

        Rscript "$__tool_directory__/mykrobe_parser.R"

        -d "collection_files"

        #if $version
            -v "$version"
        #end if
        #if $depth
            -D "$depth"
        #end if
        #if $confidence
            -c "$confidence"
        #end if
        #if $panel
            -p "$panel"
        #end if
        #if $run_name
            -n "$run_name"
        #end if

    ]]></command>
    <inputs>
    <param name="input"
        type="data" format="json,txt"
        optional="false"
        multiple="true"
        label="JSON File(s) (.JSON or .TXT)"/>
    <param name="version" type="text"
        argument="-v"        
        optional="true"
        label="Mykrobe Workflow Version"/>
    <param name="panel" type="select" label="Mykrobe Panel Version" multiple="false">
        <option value="2019">2019</option>
        <option value="2020">2020</option>
    </param>
    <param name="depth" type="integer"
        argument="-D"
        optional="true"
        label="Minimum depth of coverage"
        help="Enter integer values only. Default is 5"/>
    <param name="confidence" type="integer"
        argument="-c"
        optional="true"
        label="Confidence"
        help="Minimum genotype confidence for variant genotyping. Enter integer values only. Default is 10"/>
    <param name="run_name" type="text"
        argument="-n"
        optional="true"
        label="Name of Run"/>
    </inputs>
    <outputs>
        <data name="output_jsondata" from_work_dir="output-jsondata.csv" format="csv" label="Mykrobe jsondata"/>
        <data name="output_report" from_work_dir="output-report.csv" format="csv" label="Mykrobe report"/>
    </outputs>
    <tests>
        <test>
            <param name="input" value="prediction_2019/data/ERR031480_L6.json,prediction_2019/data/ERR125628_MBOV.json,prediction_2019/data/ERR181314_L9.json,prediction_2019/data/ERR234162_L3.json,prediction_2019/data/ERR2659153.json,prediction_2019/data/ERR266106_MCAN.json,prediction_2019/data/ERR2704812_L5.json,prediction_2019/data/ERR3335753_L1.json,prediction_2019/data/ERR4143897_MPIN.json,prediction_2019/data/ERR756348_L7.json,prediction_2019/data/ERR841495_L5.json,prediction_2019/data/SRR17089001.json,prediction_2019/data/SRR1710097_L2.json,prediction_2019/data/SRR3500411_MMUN.json,prediction_2019/data/SRR9157804.json"/>
            <param name="panel" value="2019"/>
            <output name="output_jsondata" ftype="csv" value="prediction_2019/output-jsondata.csv"/>
            <output name="output_report" ftype="csv" value="prediction_2019/output-report.csv"/>
        </test>
        <test>
            <param name="input" value="prediction_2020/data/ERR031480_L6.json,prediction_2020/data/ERR125628_MBOV.json,prediction_2020/data/ERR181314_L9.json,prediction_2020/data/ERR234162_L3.json,prediction_2020/data/ERR2659153.json,prediction_2020/data/ERR266106_MCAN.json,prediction_2020/data/ERR2704812_L5.json,prediction_2020/data/ERR3335753_L1.json,prediction_2020/data/ERR4143897_MPIN.json,prediction_2020/data/ERR756348_L7.json,prediction_2020/data/ERR841495_L5.json,prediction_2020/data/SRR17089001.json,prediction_2020/data/SRR1710097_L2.json,prediction_2020/data/SRR3500411_MMUN.json,prediction_2020/data/SRR9157804.json"/>
            <param name="panel" value="2020"/>
            <output name="output_jsondata" ftype="csv" value="prediction_2020/output-jsondata.csv"/>
            <output name="output_report" ftype="csv" value="prediction_2020/output-report.csv"/>
        </test>
        <test>
            <param name="input" value="single_2019/single2019.json"/>
            <param name="panel" value="2019"/>
            <output name="output_jsondata" ftype="csv" value="single_2019/output-jsondata.csv"/>
            <output name="output_report" ftype="csv" value="single_2019/output-report.csv"/>
        </test>
        <test>
            <param name="input" value="single_2020/single2020.json"/>
            <param name="panel" value="2020"/>
            <output name="output_jsondata" ftype="csv" value="single_2020/output-jsondata.csv"/>
            <output name="output_report" ftype="csv" value="single_2020/output-report.csv"/>
        </test>
    </tests>
    <help><![CDATA[
==============
Mykrobe Parser
==============

R Script to parse the results of mykrobe predictor and present them in a LIMS compatible format.

=====
Legal 
=====

Copyright Government of Canada 2018

Written by: National Microbiology Laboratory, Public Health Agency of Canada

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this work except in compliance with the License. You may obtain a copy of the
License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.

=======
Contact
=======

**Gary van Domselaar**: [e-mail]

    ]]></help>
    <citations>
        <citation type="bibtex">@ARTICLE{a1,
            title = {R Script to parse the results of mykrobe predictor and present them in a LIMS compatible format.},
            author = {Adrian Zetner},
            url = {https://github.com/phac-nml/mykrobe-parser}
            }
        }</citation>
    </citations>
</tool>