annotate filter-density.xml @ 0:c27b4346352f draft

"planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
author nml
date Tue, 27 Aug 2019 12:30:47 -0400
parents
children c9a43abcd993
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
1 <tool id="filterdensity" name="Filter Density" version ="1.8.2">
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>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
3 <requirements>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
4 <requirement type="package" version="1.8.2">snvphyl-tools</requirement>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
5 </requirements>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
6 <command detect_errors="exit_code">
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
7 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
8 #if $window_size:
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
9 --window_size $window_size
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
10 #end if
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
11 #if $threshold:
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
12 --threshold $threshold
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
13 #end if
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
14 </command>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
15 <inputs>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
16 <param name="vcf" type="data" label="Input vcf file" format="vcf" />
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
17 <param name="window_size" type="integer" label="Size of search window" format="" optional="true"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
18 <param name="threshold" type="integer" label="Density threshold cutoff" format="" optional="true"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
19 </inputs>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
20 <outputs>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
21 <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
22 <data format="bcf" name="filtered_bcf"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
23 </outputs>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
24 <tests>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
25 <test>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
26 <param name="threshold" value="2"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
27 <param name="window_size" value="100"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
28 <param name="vcf" value="1.vcf"/>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
29 <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
30 </test>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
31 </tests>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
32
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
33 <help>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
34 What it does
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
35 ============
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 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
38
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 Usage
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
41 =====
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 **Parameters**
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
44 - 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
45 - 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
46 - 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
47 </help>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
48
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
49 <citations>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
50 </citations>
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
51
c27b4346352f "planemo upload for repository https://github.com/phac-nml/snvphyl-galaxy commit 90a172f1fc12b9c4d73f4c924a8c0c5a559589d0"
nml
parents:
diff changeset
52 </tool>