annotate fpfilter.xml @ 1:0f17ca98338e draft default tip

Uploaded
author elixir-it
date Sat, 21 Sep 2019 13:20:34 -0400
parents 276875076be1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
276875076be1 Uploaded
elixir-it
parents:
diff changeset
1 <tool id="fpfilter" name="fpfilter" version="0.0.1">
276875076be1 Uploaded
elixir-it
parents:
diff changeset
2 <description></description>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
3 <requirements>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
4 <requirement type="package" version="0.8" >bam-readcount</requirement>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
5 <requirement type="package" >samtools</requirement>
1
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
6 <requirement type="package" version="1.0" >openssl</requirement>
0
276875076be1 Uploaded
elixir-it
parents:
diff changeset
7 </requirements>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
8 <command>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
9 perl $__tool_directory__/fpfilter.pl
276875076be1 Uploaded
elixir-it
parents:
diff changeset
10 --vcf-file ${vcf}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
11 --bam-file ${bam}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
12 --bam-index ${bam.metadata.bam_index}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
13 --sample ${sample}
1
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
14
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
15
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
16 #if $reference_source.reference_source_selector == "history"
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
17 --reference $reference_source.reference
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
18 #end if
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
19 #if $reference_source.reference_source_selector == "cached"
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
20 --reference $reference_source.ref_file.fields.path
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
21 #end if
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
22
0
276875076be1 Uploaded
elixir-it
parents:
diff changeset
23 --output ${output}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
24 --min-read-pos ${min_read_pos}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
25 --min-var-freq ${min_var_freq}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
26 --min-var-count ${min_var_count}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
27 --min-strandedness ${min_strandness}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
28 --max-mm-qualsum-diff ${max_mm_qualsum_diff}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
29 --max-var-mm-qualsum ${max_var_mm_qualsum}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
30 --max-mapqual-diff ${max_mapqual_diff}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
31 --max-readlen-diff ${max_readlen_diff}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
32 --min-var-dist-3 ${min_var_dist_3}
276875076be1 Uploaded
elixir-it
parents:
diff changeset
33 </command>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
34
276875076be1 Uploaded
elixir-it
parents:
diff changeset
35 <inputs>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
36 <param name="vcf" format="vcf" type="data" label="VCF File" help="The input VCF file. Must have a GT field." />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
37 <param name="bam" format="bam" type="data" label="bam file" help="The BAM file of the sample you are filtering on. Typically the tumor." />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
38 <param name="sample" type="text" label="Sample" value="sample" help="The sample name of the sample you want to filter on in the VCF file." />
1
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
39 <conditional name="reference_source">
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
40 <param name="reference_source_selector" type="select" label="Will you select a reference genome from your history or use a built-in index?">
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
41 <option value="cached">Use a built-in genome</option>
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
42 <option value="history">Use a genome from history as reference</option>
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
43 </param>
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
44 <when value="cached">
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
45 <param name="ref_file" type="select" label="Using reference genome" help="Select genome from the list">
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
46 <options from_data_table="fpf_index">
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
47 <filter type="sort_by" column="2" />
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
48 <validator type="no_options" message="No indexes are available" />
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
49 </options>
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
50 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
51 </param>
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
52 </when>
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
53 <when value="history">
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
54 <param name="reference" type="data" format="fasta" label="Use the following dataset as the reference sequence" help="You can upload a FASTA sequence to the history and use it as reference" />
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
55 </when>
0f17ca98338e Uploaded
elixir-it
parents: 0
diff changeset
56 </conditional>
0
276875076be1 Uploaded
elixir-it
parents:
diff changeset
57 <param name="min_read_pos" type="float" value="0.10" label="Min Read Pos" help="Minimum average relative distance from start/end of read." />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
58 <param name="min_var_freq" type="float" value="0.05" label="Min Var Freq" help="Minimum variant allele frequency." />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
59 <param name="min_var_count" type="integer" value="4" label="Min Var Count" help="Minimum number of variant-supporting reads." />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
60
276875076be1 Uploaded
elixir-it
parents:
diff changeset
61 <param name="min_strandness" type="float" value="0.01" label="Min Strandness" help="Minimum representation of variant allele on each strand." />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
62 <param name="max_mm_qualsum_diff" type="integer" value="50" label="Max mm qualsum diff" help="Maximum difference of mismatch quality sum between variant and reference reads (paralog filter)." />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
63
276875076be1 Uploaded
elixir-it
parents:
diff changeset
64 <param name="max_var_mm_qualsum" type="integer" value="100" label="Max var mm qualsum" help="Maximum mismatch quality sum of reference-supporting reads." />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
65 <param name="max_mapqual_diff" type="integer" value="30" label="Max mapqual diff" help="Maximum difference of mapping quality between variant and reference reads." />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
66
276875076be1 Uploaded
elixir-it
parents:
diff changeset
67 <param name="max_readlen_diff" type="integer" value="25" label="Max readlen diff" help="Maximum difference of average supporting read length between variant and reference reads (paralog filter)" />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
68 <param name="min_var_dist_3" type="float" value="0.20" label="Min var dist 3 " help="minimum average distance to effective 3prime end of read (real end or Q2) for variant-supporting reads" />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
69
276875076be1 Uploaded
elixir-it
parents:
diff changeset
70 </inputs>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
71
276875076be1 Uploaded
elixir-it
parents:
diff changeset
72 <outputs>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
73 <data format="vcf" name="output" label="FP Filtered VCF" />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
74 </outputs>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
75 <stdio>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
76 <exit_code range="1:" level="fatal" />
276875076be1 Uploaded
elixir-it
parents:
diff changeset
77 </stdio>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
78 <help>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
79 --vcf-file the input VCF file. Must have a GT field.
276875076be1 Uploaded
elixir-it
parents:
diff changeset
80 --bam-file the BAM file of the sample you are filtering on. Typically the tumor.
276875076be1 Uploaded
elixir-it
parents:
diff changeset
81 --sample the sample name of the sample you want to filter on in the VCF file.
276875076be1 Uploaded
elixir-it
parents:
diff changeset
82 --reference-sequence a fasta containing the reference sequence the BAM file was aligned to.
276875076be1 Uploaded
elixir-it
parents:
diff changeset
83 --output the filename of the output VCF file
276875076be1 Uploaded
elixir-it
parents:
diff changeset
84 --min-read-pos minimum average relative distance from start/end of read
276875076be1 Uploaded
elixir-it
parents:
diff changeset
85 --min-var-freq minimum variant allele frequency
276875076be1 Uploaded
elixir-it
parents:
diff changeset
86 --min-var-count minimum number of variant-supporting reads
276875076be1 Uploaded
elixir-it
parents:
diff changeset
87 --min-strandedness minimum representation of variant allele on each strand
276875076be1 Uploaded
elixir-it
parents:
diff changeset
88 --max-mm-qualsum-diff maximum difference of mismatch quality sum between variant and reference reads (paralog filter)
276875076be1 Uploaded
elixir-it
parents:
diff changeset
89 --max_var_mm_qualsum maximum mismatch quality sum of reference-supporting reads
276875076be1 Uploaded
elixir-it
parents:
diff changeset
90 --max-mapqual-diff maximum difference of mapping quality between variant and reference reads
276875076be1 Uploaded
elixir-it
parents:
diff changeset
91 --max-readlen-diff maximum difference of average supporting read length between variant and reference reads (paralog filter)
276875076be1 Uploaded
elixir-it
parents:
diff changeset
92 --min-var-dist-3 minimum average distance to effective 3prime end of read (real end or Q2) for variant-supporting reads
276875076be1 Uploaded
elixir-it
parents:
diff changeset
93
276875076be1 Uploaded
elixir-it
parents:
diff changeset
94 this wrapper has been developed from the existing script at https://github.com/ucscCancer/fpfilter-tool/blob/master/fpfilter.xml , only the requirement and part of the command line have been changed in order to make it suitable for CONDA
276875076be1 Uploaded
elixir-it
parents:
diff changeset
95 </help>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
96
276875076be1 Uploaded
elixir-it
parents:
diff changeset
97 <tests>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
98 <test>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
99 </test>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
100 </tests>
276875076be1 Uploaded
elixir-it
parents:
diff changeset
101
276875076be1 Uploaded
elixir-it
parents:
diff changeset
102 </tool>