annotate tb_profiler_collate.xml @ 0:5b218b5eedb6 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
author iuc
date Tue, 21 Oct 2025 10:24:27 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
1 <tool id="tb_profiler_collate" name="TB-Profiler Collate" version="@TOOL_VERSION@+galaxy1" profile="21.05">
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
2 <description>Combines multiple TB-Profiler JSON reports into summary and variants reports</description>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
3
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
4 <macros>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
5 <import>macros.xml</import>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
6 </macros>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
7
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
8 <requirements>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
9 <requirement type="package" version="@TOOL_VERSION@">tb-profiler</requirement>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
10 </requirements>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
11
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
12 <expand macro="version_command"/>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
13
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
14 <command detect_errors="exit_code"><![CDATA[
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
15 #for $dataset in $input_files
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
16 python '$__tool_directory__/replace_id_field_with_element_id.py' '$dataset' '$dataset.element_identifier' &&
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
17 #end for
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
18
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
19 tb-profiler collate --dir .
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
20 ]]></command>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
21
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
22 <inputs>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
23 <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."/>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
24 </inputs>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
25
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
26 <outputs>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
27 <data name="output_tabular" format="tabular" label="${tool.name} on ${on_string}: Summary Report (tabular)" from_work_dir="tbprofiler.txt">
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
28 <actions>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
29 <action name="column_names" type="metadata" default="sample,main_lineage,sub_lineage,spoligotype,drtype,target_median_depth,pct_reads_mapped,num_reads_mapped,num_dr_variants,num_other_variants,rifampicin,isoniazid,ethambutol,pyrazinamide,moxifloxacin,levofloxacin,bedaquiline,delamanid,pretomanid,linezolid,streptomycin,amikacin,kanamycin,capreomycin,clofazimine,ethionamide,para-aminosalicylic_acid,cycloserine"/>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
30 <action type="metadata" name="detect_metadata"/>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
31 </actions>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
32 </data>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
33 <data name="output_csv" format="csv" label="${tool.name} on ${on_string}: Variants Report (CSV)" from_work_dir="tbprofiler.variants.csv"/>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
34 <data name="output_variants" format="txt" label="${tool.name} on ${on_string}: Variants Report (TXT)" from_work_dir="tbprofiler.variants.txt"/>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
35 </outputs>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
36
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
37 <tests>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
38 <test expect_num_outputs="3">
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
39 <param name="input_files">
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
40 <collection type="list">
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
41 <element name="ERR2510682" value="ERR2510682.results.json" ftype="json"/>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
42 </collection>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
43 </param>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
44
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
45 <output name="output_tabular" file="tbprofiler_test_1_sample.txt" ftype="tabular"/>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
46 <output name="output_csv" file="tbprofiler_test_1_sample.variants.csv"/>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
47 <output name="output_variants" file="tbprofiler_test_1_sample.variants.txt"/>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
48 </test>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
49 </tests>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
50
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
51 <help><![CDATA[
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
52 TB-Profiler Collate Tool
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
53
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
54 This tool combines multiple TB-Profiler JSON reports into consolidated outputs, summarizing lineage, antimicrobial resistance (AMR) profiles, and variants across samples.
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
55
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
56 Inputs
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
57 - A collection of TB-Profiler JSON reports generated from individual samples.
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
58
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
59 Outputs
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
60 1. Summary Report (tbprofiler.txt): Overview of sample lineages and AMR predictions.
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
61 2. Variants CSV (tbprofiler.variants.csv): Table of identified variants across all samples.
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
62 3. Variants Text (tbprofiler.variants.txt): Text file of variant details for quick inspection.
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
63
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
64 Usage Notes
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
65 - Ensure all input JSON files are valid TB-Profiler outputs.
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
66
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
67 ]]></help>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
68
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
69 <citations>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
70 <citation type="doi">10.1186/s13073-019-0676-5</citation>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
71 </citations>
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
72
5b218b5eedb6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/tb-profiler commit 7dba70c70c9fe33353a0fd21803b11cfddc42c32
iuc
parents:
diff changeset
73 </tool>