annotate tb_profiler_collate.xml @ 0:9fae5576604a draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
author iuc
date Fri, 05 Sep 2025 12:50:05 +0000
parents
children e9568d48ee11
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
1 <tool id="tb_profiler_collate" name="TB-Profiler Collate" version="@TOOL_VERSION@@VERSION_SUFFIX@" profile="21.05">
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
2 <description>Combines multiple TB-Profiler JSON reports into summary and variants reports</description>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
3
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
4 <macros>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
5 <import>macros.xml</import>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
6 </macros>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
7
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
8 <requirements>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
9 <requirement type="package" version="@TOOL_VERSION@">tb-profiler</requirement>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
10 </requirements>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
11
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
12 <expand macro="version_command"/>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
13
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
14 <command detect_errors="exit_code"><![CDATA[
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
15 #for $dataset in $input_files
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
16 python '$__tool_directory__/replace_id_field_with_element_id.py' '$dataset' '$dataset.element_identifier' &&
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
17 #end for
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
18
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
19 tb-profiler collate --dir .
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
20
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
21 ]]></command>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
22
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
23 <inputs>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
24 <param type="data_collection" name="input_files" label="TB-Profiler JSON Reports" collection_type="list" format="json" help="Enter a list of TB-Profiler JSON reports to collate."/>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
25 </inputs>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
26
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
27 <outputs>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
28 <data name="output_txt" format="txt" label="${tool.name} on ${on_string}: Summary Report" from_work_dir="tbprofiler.txt"/>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
29 <data name="output_csv" format="csv" label="${tool.name} on ${on_string}: Variants Report (CSV)" from_work_dir="tbprofiler.variants.csv"/>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
30 <data name="output_variants" format="txt" label="${tool.name} on ${on_string}: Variants Report (TXT)" from_work_dir="tbprofiler.variants.txt"/>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
31 </outputs>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
32
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
33 <tests>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
34 <test expect_num_outputs="3">
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
35 <param name="input_files">
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
36 <collection type="list">
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
37 <element name="ERR2510682" value="ERR2510682.results.json" ftype="json"/>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
38 </collection>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
39 </param>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
40
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
41 <output name="output_txt" file="tbprofiler_test_1_sample.txt"/>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
42 <output name="output_csv" file="tbprofiler_test_1_sample.variants.csv"/>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
43 <output name="output_variants" file="tbprofiler_test_1_sample.variants.txt"/>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
44 </test>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
45 </tests>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
46
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
47 <help><![CDATA[
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
48 TB-Profiler Collate Tool
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
49
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
50 This tool combines multiple TB-Profiler JSON reports into consolidated outputs, summarizing lineage, antimicrobial resistance (AMR) profiles, and variants across samples.
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
51
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
52 Inputs
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
53 - A collection of TB-Profiler JSON reports generated from individual samples.
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
54
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
55 Outputs
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
56 1. Summary Report (tbprofiler.txt): Overview of sample lineages and AMR predictions.
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
57 2. Variants CSV (tbprofiler.variants.csv): Table of identified variants across all samples.
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
58 3. Variants Text (tbprofiler.variants.txt): Text file of variant details for quick inspection.
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
59
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
60 Usage Notes
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
61 - Ensure all input JSON files are valid TB-Profiler outputs.
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
62
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
63 ]]></help>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
64
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
65 <citations>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
66 <citation type="doi">10.1186/s13073-019-0676-5</citation>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
67 </citations>
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
68
9fae5576604a planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tools/tb-profiler commit a6f87bb33981b0fc0c9b7a9dd822259d9a29a3a1
iuc
parents:
diff changeset
69 </tool>