annotate drmutations.xml @ 9:18aad692772a draft default tip

planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
author nml
date Mon, 20 Jun 2022 20:06:36 +0000
parents 9def47f3c1e4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
18aad692772a planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
nml
parents: 8
diff changeset
1 <tool id="drmutations" name="Drug Resistance Mutations" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
2 <description></description>
9
18aad692772a planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
nml
parents: 8
diff changeset
3 <macros>
18aad692772a planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
nml
parents: 8
diff changeset
4 <import>macros.xml</import>
18aad692772a planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
nml
parents: 8
diff changeset
5 </macros>
18aad692772a planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
nml
parents: 8
diff changeset
6 <expand macro="requirements"/>
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
8
9
18aad692772a planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
nml
parents: 8
diff changeset
9 ln -s $input_bam '${input_bam.name}' &&
18aad692772a planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
nml
parents: 8
diff changeset
10 ln -s $input_bam.metadata.bam_index '${input_bam.name}.bai' &&
18aad692772a planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
nml
parents: 8
diff changeset
11
18aad692772a planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
nml
parents: 8
diff changeset
12 quasitools drmutations '${input_bam.name}' $ref_file $var_file $input_genes
5
b69e898b8109 planemo upload for repository https://github.com/phac-nml/quasitools commit e30c0687f755a46c5b3bd265a1478a1abf5dc9f1
nml
parents: 4
diff changeset
13
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
14 #if $mutation_db:
5
b69e898b8109 planemo upload for repository https://github.com/phac-nml/quasitools commit e30c0687f755a46c5b3bd265a1478a1abf5dc9f1
nml
parents: 4
diff changeset
15 $mutation_db
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
16 #end if
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
17
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
18 #if $min_freq:
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
19 -f $min_freq
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
20 #end if
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
21
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
22 #if $reporting_thres:
5
b69e898b8109 planemo upload for repository https://github.com/phac-nml/quasitools commit e30c0687f755a46c5b3bd265a1478a1abf5dc9f1
nml
parents: 4
diff changeset
23 -t $reporting_thres
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
24 #end if
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
25
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
26 -o output.csv
5
b69e898b8109 planemo upload for repository https://github.com/phac-nml/quasitools commit e30c0687f755a46c5b3bd265a1478a1abf5dc9f1
nml
parents: 4
diff changeset
27
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
28 ]]></command>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
29 <inputs>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
30 <param name="input_bam" type="data" format="bam" optional="false" label="Bam file" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
31 <param name="ref_file" type="data" format="fasta" optional="false" label="Reference file" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
32 <param name="var_file" type="data" format="vcf" optional="false" label="Variants file" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
33 <param name="input_genes" type="data" format="bed" optional="false" label="Gene file" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
34 <param name="mutation_db" type="data" format="tsv" optional="false" label="Mutation DB" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
35 <param name="min_freq" type="float" optional="true" min="0" max="1" label="Minimum frequency" value="0.01" help="The minimum required frequency. Defaults to 0.01." />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
36 <param name="reporting_thres" type="integer" min="1" max="20" optional="true" label="Reporting threshold" value="1"
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
37 help="The minimum percentage required for an entry in the drug resistant report. Defaults to 1."/>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
38 </inputs>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
39 <outputs>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
40 <data format="csv" name="output" from_work_dir="output.csv" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
41 </outputs>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
42 <tests>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
43 <test>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
44 <param name="input_bam" value="align.bam" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
45 <param name="ref_file" value="hxb2_pol.fas" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
46 <param name="var_file" value="nt_variants.vcf" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
47 <param name="input_genes" ftype="bed" value="hxb2_pol.bed" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
48 <param name="mutation_db" value="mutation_db.tsv" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
49 <output name="output" >
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
50 <assert_contents>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
51 <has_text text="Chromosome,Gene,Category,Surveillance,Wildtype,Position,Mutation,Mutation Frequency,Coverage" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
52 <has_text text="hxb2_pol,RT,NNRTI,Yes,K,103,N,7.79,154" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
53 </assert_contents>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
54 </output>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
55 </test>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
56 </tests>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
57 <help><![CDATA[
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
58
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
59 Drug Resistance Mutations
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
60 =========================
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
61
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
62 Generates a report detailing the drug resistant mutations found, above the reporting threshold (default: 1%).
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
63
7
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
64 ------
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
65 Inputs
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
66 ------
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
67
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
68 1. A BAM file.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
69 2. A reference FASTA file.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
70 3. A variants (.vcf) file.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
71 4. A genes (.bed) file.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
72 5. A mutation database (.tsv) file.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
73
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
74 ----------
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
75 Parameters
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
76 ----------
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
77 1. The minimum required frequency for a variant to be considered. Defaults to 0.01.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
78 2. The reporting threshold a mutation must pass to be included in the report.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
79
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
80 -------
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
81 Outputs
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
82 -------
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
83
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
84 A CSV file containing the drug resistant mutations found.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
85
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
86 ]]></help>
9
18aad692772a planemo upload for repository https://github.com/phac-nml/quasitools commit 5a9e4c9a582828654893166caf20576f5e0c418e
nml
parents: 8
diff changeset
87 <expand macro="citations" />
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
88 </tool>