annotate drmutations.xml @ 8:9def47f3c1e4 draft

planemo upload for repository https://github.com/phac-nml/quasitools commit 940b463cac33438233bc7a8a1695ca6d34b31a35
author nml
date Tue, 06 Aug 2019 08:50:28 -0400
parents dcd43b402eb3
children 18aad692772a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
9def47f3c1e4 planemo upload for repository https://github.com/phac-nml/quasitools commit 940b463cac33438233bc7a8a1695ca6d34b31a35
nml
parents: 7
diff changeset
1 <tool id="drmutations" name="Drug Resistance Mutations" version="0.7.0">
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
2 <description></description>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
3 <requirements>
8
9def47f3c1e4 planemo upload for repository https://github.com/phac-nml/quasitools commit 940b463cac33438233bc7a8a1695ca6d34b31a35
nml
parents: 7
diff changeset
4 <requirement type="package" version="0.7.0">quasitools</requirement>
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
5 </requirements>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
7
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
8 ln -f -s ${input_bam.metadata.bam_index} ${input_bam}.bai &&
5
b69e898b8109 planemo upload for repository https://github.com/phac-nml/quasitools commit e30c0687f755a46c5b3bd265a1478a1abf5dc9f1
nml
parents: 4
diff changeset
9 quasitools drmutations $input_bam $ref_file $var_file $input_genes
b69e898b8109 planemo upload for repository https://github.com/phac-nml/quasitools commit e30c0687f755a46c5b3bd265a1478a1abf5dc9f1
nml
parents: 4
diff changeset
10
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
11 #if $mutation_db:
5
b69e898b8109 planemo upload for repository https://github.com/phac-nml/quasitools commit e30c0687f755a46c5b3bd265a1478a1abf5dc9f1
nml
parents: 4
diff changeset
12 $mutation_db
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
13 #end if
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
14
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
15 #if $min_freq:
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
16 -f $min_freq
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
17 #end if
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
18
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
19 #if $reporting_thres:
5
b69e898b8109 planemo upload for repository https://github.com/phac-nml/quasitools commit e30c0687f755a46c5b3bd265a1478a1abf5dc9f1
nml
parents: 4
diff changeset
20 -t $reporting_thres
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
21 #end if
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
22
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
23 -o output.csv
5
b69e898b8109 planemo upload for repository https://github.com/phac-nml/quasitools commit e30c0687f755a46c5b3bd265a1478a1abf5dc9f1
nml
parents: 4
diff changeset
24
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
25 ]]></command>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
26 <inputs>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
27 <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
28 <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
29 <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
30 <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
31 <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
32 <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
33 <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
34 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
35 </inputs>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
36 <outputs>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
37 <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
38 </outputs>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
39 <tests>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
40 <test>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
41 <param name="input_bam" value="align.bam" />
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
42 <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
43 <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
44 <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
45 <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
46 <output name="output" >
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
47 <assert_contents>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
48 <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
49 <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
50 </assert_contents>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
51 </output>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
52 </test>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
53 </tests>
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
54 <help><![CDATA[
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
55
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
56 Drug Resistance Mutations
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
57 =========================
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 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
60
7
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
61 ------
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
62 Inputs
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
63 ------
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 1. A BAM file.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
66 2. A reference FASTA file.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
67 3. A variants (.vcf) file.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
68 4. A genes (.bed) file.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
69 5. A mutation database (.tsv) file.
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
70
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
71 ----------
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
72 Parameters
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 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
75 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
76
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
77 -------
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
78 Outputs
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 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
82
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
83 ]]></help>
7
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
84 <citations>
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
85 <citation type="bibtex">
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
86 @misc{GitHubquasitoolsdrmutations,
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
87 title = {quasitools drmutations},
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
88 publisher = {phac-nml},
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
89 journal = {GitHub repository},
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
90 url = {https://github.com/phac-nml/quasitools},
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
91 }
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
92 </citation>
dcd43b402eb3 planemo upload for repository https://github.com/phac-nml/quasitools commit ce3f1b19e7e110ff47365c672bc6fa17cce0a314
nml
parents: 5
diff changeset
93 </citations>
0
71976cfc9022 planemo upload for repository https://github.com/phac-nml/quasitools commit 8a264400a75945e2e0fdd5a08c007a8b1b7a2f0f
nml
parents:
diff changeset
94 </tool>