annotate filter-density.xml @ 1:c9a43abcd993 draft default tip

"planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 57067916cb7b9c5b65c1da59d4bbb846c3e3af2f"
author nml
date Tue, 23 Jun 2020 10:25:36 -0400
parents c27b4346352f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
c9a43abcd993 "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 57067916cb7b9c5b65c1da59d4bbb846c3e3af2f"
nml
parents: 0
diff changeset
1 <tool id="filterdensity" name="Filter Density" version ="@VERSION@+galaxy1">
0
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
2 <description>Identify high density positions within indvidual genomes</description>
1
c9a43abcd993 "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 57067916cb7b9c5b65c1da59d4bbb846c3e3af2f"
nml
parents: 0
diff changeset
3 <macros>
c9a43abcd993 "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 57067916cb7b9c5b65c1da59d4bbb846c3e3af2f"
nml
parents: 0
diff changeset
4 <import>macros.xml</import>
c9a43abcd993 "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 57067916cb7b9c5b65c1da59d4bbb846c3e3af2f"
nml
parents: 0
diff changeset
5 </macros>
c9a43abcd993 "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 57067916cb7b9c5b65c1da59d4bbb846c3e3af2f"
nml
parents: 0
diff changeset
6 <expand macro="requirements"/>
0
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
7 <command detect_errors="exit_code">
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
8 bcftools plugin filter_snv_density $vcf -O b -o $filtered_bcf -- --filename $vcf --region_file $out
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
9 #if $window_size:
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
10 --window_size $window_size
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
11 #end if
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
12 #if $threshold:
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
13 --threshold $threshold
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
14 #end if
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
15 </command>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
16 <inputs>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
17 <param name="vcf" type="data" label="Input vcf file" format="vcf" />
1
c9a43abcd993 "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 57067916cb7b9c5b65c1da59d4bbb846c3e3af2f"
nml
parents: 0
diff changeset
18 <param name="window_size" type="integer" min="1" label="Size of search window" format="" optional="true"/>
c9a43abcd993 "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 57067916cb7b9c5b65c1da59d4bbb846c3e3af2f"
nml
parents: 0
diff changeset
19 <param name="threshold" type="integer" min="1" label="Density threshold cutoff" format="" optional="true"/>
0
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
20 </inputs>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
21 <outputs>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
22 <data format="txt" name="out" label="High density regions"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
23 <data format="bcf" name="filtered_bcf"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
24 </outputs>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
25 <tests>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
26 <test>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
27 <param name="threshold" value="2"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
28 <param name="window_size" value="100"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
29 <param name="vcf" value="1.vcf"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
30 <output name="out" file="density_regions.txt"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
31 </test>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
32 </tests>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
33
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
34 <help>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
35 What it does
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
36 ============
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
37
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
38 This script will indentify all high density SNV regions in an isolate genome, marking them as filtered-density in the associated bcf, if desired.
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
39
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
40
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
41 Usage
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
42 =====
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
43
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
44 **Parameters**
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
45 - vcf - A vcf file to be analyzed for SNV density.
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
46 - threshold - The threshold distance between SNV's in order for them to be considered 'high density'
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
47 - window_size - The size of the window, in base pairs, that will be looked at at any given time to calculate density.
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
48 </help>
1
c9a43abcd993 "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 57067916cb7b9c5b65c1da59d4bbb846c3e3af2f"
nml
parents: 0
diff changeset
49 <expand macro="citations"/>
0
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
50 </tool>