annotate parse_mykrobe_predict.xml @ 1:0ac12c344bfa draft default tip

planemo upload for repository https://github.com/katholt/sonneityping commit 4d048786a4cf9ecb045fa3263084f98105c15557
author iuc
date Tue, 12 Mar 2024 15:37:17 +0000
parents db4fe7172114
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
1 <tool id="sonneityping" name="parse mykrobe predict" version="@TOOL_VERSION@" profile="20.05">
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
2 <description>for Shigella sonnei and tabulate results into a single tab-delimited file</description>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
3 <macros>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
5 </macros>
1
0ac12c344bfa planemo upload for repository https://github.com/katholt/sonneityping commit 4d048786a4cf9ecb045fa3263084f98105c15557
iuc
parents: 0
diff changeset
6 <xrefs>
0ac12c344bfa planemo upload for repository https://github.com/katholt/sonneityping commit 4d048786a4cf9ecb045fa3263084f98105c15557
iuc
parents: 0
diff changeset
7 <xref type="bio.tools">sonneityping</xref>
0ac12c344bfa planemo upload for repository https://github.com/katholt/sonneityping commit 4d048786a4cf9ecb045fa3263084f98105c15557
iuc
parents: 0
diff changeset
8 </xrefs>
0
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
9 <expand macro="requirements"/>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
11 parse_mykrobe_predict --jsons
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
12
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
13 #for $i in $json
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
14 '$i'
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
15 #end for
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
16
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
17 #if $optional.alleles:
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
18 --alleles '$optional.alleles'
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
19 #end if
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
20
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
21 --prefix results
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
22
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
23 ]]></command>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
24 <inputs>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
25 <param name="json" type="data" format="json" multiple="true" optional="false" label="Mykrobe results to parse." help="Mykrobe predict results in JSON format." />
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
26
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
27 <section name="optional" title="Optional Parameters" expanded="false">
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
28 <param name="alleles" type="data" format="txt,tabular" optional="true" label="Alleles" help="Links each lineage name to its human-readable counterpart." />
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
29 </section>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
30 </inputs>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
31 <outputs>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
32 <data format="tabular" label="parsed output" name="parsed_output" from_work_dir="results_predictResults.tsv" />
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
33 </outputs>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
34 <tests>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
35 <test>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
36 <param name="json" ftype="json" value="SRR6114360.json"/>
1
0ac12c344bfa planemo upload for repository https://github.com/katholt/sonneityping commit 4d048786a4cf9ecb045fa3263084f98105c15557
iuc
parents: 0
diff changeset
37 <param name="alleles" ftype="txt" value="alleles.txt" />
0
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
38 <output name="parsed_output">
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
39 <assert_contents>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
40 <has_text text="3.7.30.4" />
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
41 <has_text text="S. sonnei" />
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
42 </assert_contents>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
43 </output>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
44 </test>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
45 <test>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
46 <param name="json" ftype="json" value="SRR6114360.json"/>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
47 <output name="parsed_output">
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
48 <assert_contents>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
49 <has_text text="3.7.30.4" />
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
50 <has_text text="S. sonnei" />
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
51 </assert_contents>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
52 </output>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
53 </test>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
54 </tests>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
55 <help><![CDATA[
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
56 Parse Mykrobe Predict
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
57 =====================
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
58
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
59 Parses Mykrobe predict results for Shigella sonnei.
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
60
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
61 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).
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
62
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
63 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>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
64 <citations>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
65 <citation type="bibtex">
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
66 @misc{GitHubsonneityping,
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
67 title = {sonneityping},
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
68 journal = {GitHub Repository},
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
69 url = {https://github.com/katholt/sonneityping},
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
70 }
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
71 </citation>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
72 </citations>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
73 </tool>
db4fe7172114 "planemo upload for repository https://github.com/katholt/sonneityping commit 1b4231e8f98a234c29f57fef400f58f14645dc95"
iuc
parents:
diff changeset
74