annotate screen_abricate_report.xml @ 2:912a3a3dc082 draft

"planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
author public-health-bioinformatics
date Thu, 19 Dec 2019 20:31:11 -0500
parents 4f963b583186
children 2262e531c50b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
1 <tool id="screen_abricate_report" name="Screen Abricate Report" version="0.2.0">
0
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
2 <description>Screens an abricate report for genes of interest</description>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
3 <requirements>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
4 </requirements>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
5 <command detect_errors="exit_code"><![CDATA[
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
6 '${__tool_directory__}/screen_abricate_report.py'
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
7 '${abricate_report}'
2
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
8 #if str( $screening_file_source.screening_file_source_selector ) == "tool_data_table":
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
9 #set $input_screening_file = str( $screening_file_source.screening_file.fields.path )
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
10 #else:
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
11 #set $input_screening_file = str( $screening_file_source.screening_file )
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
12 #end if
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
13 --screening_file '${input_screening_file}'
0
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
14 --screened_report '${screened_report}'
2
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
15 --gene_detection_status '${gene_detection_status}' &&
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
16 cp '${input_screening_file}' '${output_screening_file}'
0
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
17 ]]></command>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
18 <inputs>
2
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
19 <conditional name="screening_file_source">
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
20 <param name="screening_file_source_selector" type="select" label="Select a gene screening file from your history or use one from a tool data table?"
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
21 help="Screening files must be stored in the 'abricate_report_screening_files' tool data table">
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
22 <option value="tool_data_table">From tool data table</option>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
23 <option value="history">From history</option>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
24 </param>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
25 <when value="tool_data_table">
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
26 <param name="screening_file" type="select" format="tabular">
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
27 <options from_data_table="abricate_report_screening_files">
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
28 <validator type="no_options" message="No abricate report screening files are available" />
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
29 </options>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
30 </param>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
31 </when>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
32 <when value="history">
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
33 <param name="screening_file" type="data" format="tabular" label="Gene screening file" help="A two-column tab-delimited file with gene names and regular expressions" />
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
34 </when>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
35 </conditional>
0
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
36 <param name="abricate_report" type="data" format="tabular" />
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
37 </inputs>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
38 <outputs>
1
4f963b583186 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit c27095ceaf23aa2c910e0ea866db9ec8d3e7816b"
public-health-bioinformatics
parents: 0
diff changeset
39 <data name="screened_report" format="tabular" label="Screened Abricate Report" />
4f963b583186 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit c27095ceaf23aa2c910e0ea866db9ec8d3e7816b"
public-health-bioinformatics
parents: 0
diff changeset
40 <data name="gene_detection_status" format="tabular" label="Gene Detection Status" />
2
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
41 <data name="output_screening_file" format="tabular" />
0
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
42 </outputs>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
43 <tests>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
44 <test>
2
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
45 <param name="screening_file_source.screening_file_source_selector" value="tool_data_table" />
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
46 <param name="screening_file_source.screening_file" value="test_entry"/>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
47 <param name="abricate_report" value="SAMN13042171_abricate_report.tsv"/>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
48 <output name="screened_report" file="SAMN13042171_abricate_report_screened.tsv" ftype="tabular"/>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
49 <output name="gene_detection_status" file="SAMN13042171_gene_detection_status.tsv" ftype="tabular"/>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
50 </test>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
51 <test>
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
52 <param name="screening_file_source.screening_file_source_selector" value="history" />
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
53 <param name="screening_file_source.screening_file" value="screening_file.tsv"/>
0
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
54 <param name="abricate_report" value="SAMN13042171_abricate_report.tsv"/>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
55 <output name="screened_report" file="SAMN13042171_abricate_report_screened.tsv" ftype="tabular"/>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
56 <output name="gene_detection_status" file="SAMN13042171_gene_detection_status.tsv" ftype="tabular"/>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
57 </test>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
58 </tests>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
59 <help><![CDATA[
2
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
60 This tool is used to filter (ie. 'screen') an abricate report to only include
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
61 specific genes of interest.
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
62
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
63 A list of genes is supplied in a 'screening file', which is a two-column .tsv
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
64 with headers 'gene_name' and 'regex'. The first column gives the name of the
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
65 gene of interest, and the second column is a regular expression that can be used
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
66 to identify examples of that gene in the 'GENE' column of the abricate report.
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
67
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
68 For example, one might use the regex 'KPC\-{d+}' to identify all alleles of the
912a3a3dc082 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 2ec76aac2fcf466fc16091bfff8b7cb83fd92467"
public-health-bioinformatics
parents: 1
diff changeset
69 KPC gene (KPC-2, KPC-3, KPC-4, ..., KPC-10, ...)
0
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
70 ]]></help>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
71 <citations>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
72 </citations>
b2d56a44a872 "planemo upload for repository https://github.com/public-health-bioinformatics/galaxy_tools/blob/master/tools/screen_abricate_report commit 1d569fc27b052d1982d82ca19455caaff6386f46"
public-health-bioinformatics
parents:
diff changeset
73 </tool>