Mercurial > repos > sanbi-uwc > vcf_snps_utils

annotate intersect.xml @ 2:cb2055ee4e6c draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit 25c750eea54d573ae0dcd3e5af23cffb8ba4c63b
author sanbi-uwc
date Thu, 16 Aug 2018 08:25:04 -0400
parents f8f16a682d01
children ec601f9af09b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
1 <?xml version="1.0"?>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
2 <tool id="intersect" name="Intersect SNPs with a CSV file" version="@TOOL_VERSION@+galaxy0" profile="17.01">
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
3 <description>Intersect SNPs with a CSV file</description>
1
f8f16a682d01 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit cfb04d59b0377b23ddc1264ddcf8677f2b191aa8
sanbi-uwc
parents: 0
diff changeset
4 <macros>
2
cb2055ee4e6c planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit 25c750eea54d573ae0dcd3e5af23cffb8ba4c63b
sanbi-uwc
parents: 1
diff changeset
5 <token name="@TOOL_VERSION@">0.0.2</token>
0
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
6 </macros>
2
cb2055ee4e6c planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit 25c750eea54d573ae0dcd3e5af23cffb8ba4c63b
sanbi-uwc
parents: 1
diff changeset
7
cb2055ee4e6c planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit 25c750eea54d573ae0dcd3e5af23cffb8ba4c63b
sanbi-uwc
parents: 1
diff changeset
8 <requirements>
cb2055ee4e6c planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit 25c750eea54d573ae0dcd3e5af23cffb8ba4c63b
sanbi-uwc
parents: 1
diff changeset
9 <requirement type="package" version="@TOOL_VERSION@">vcf_snps_utils</requirement>
cb2055ee4e6c planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit 25c750eea54d573ae0dcd3e5af23cffb8ba4c63b
sanbi-uwc
parents: 1
diff changeset
10 </requirements>
0
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
11
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
12 <command detect_errors="exit_code"><![CDATA[
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
13 ln -s '$input_vcf' data.vcf &&
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
14 ln -s '$input_csv' data.csv &&
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
15 vcf_snps_utils intersect data.vcf data.csv --out "$output_pdf.file.path"
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
16 ]]>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
17 </command>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
18
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
19 <inputs>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
20 <param name="input_vcf" type="data" format="vcf" label="Input VCF" />
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
21 <param name="input_csv" type="data" format="csv" label="Input CSV" />
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
22 </inputs>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
23
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
24 <outputs>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
25 <data name="output_pdf" format="pdf" label="SNPs Intersection Report" />
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
26 <data name="output_txt" format="txt" label="SNPs Intersection Combination Report" />
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
27 <data name="output_r" format="R" label="SNPs Intersection R object" />
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
28 </outputs>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
29
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
30 <tests>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
31 <test>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
32 <param name="input_vcf" value="sample1.vcf" />
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
33 <output name="output" compare="diff" lines_diff="2" file="sample1.html" ftype="html" />
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
34 </test>
1
f8f16a682d01 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit cfb04d59b0377b23ddc1264ddcf8677f2b191aa8
sanbi-uwc
parents: 0
diff changeset
35 </tests>
2
cb2055ee4e6c planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit 25c750eea54d573ae0dcd3e5af23cffb8ba4c63b
sanbi-uwc
parents: 1
diff changeset
36
0
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
37 <help>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
38
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
39 **What it does**
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
40
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
41 Intersect SNPs and generate an output report from a CSV file of knowned SNPs (workflow generated/annotated)
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
42
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
43 Usage: vcf_snps_utils intersect [OPTIONS] [VCFFILES]... CSVFILE
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
44
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
45 -----
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
46
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
47 **Example**
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
48
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
49 VCF snp intersect tool (CSV file).
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
50
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
51 This tools compares CSV snps to the VCF snps This is to establish whether
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
52 the discovered (VCF snps) have been discovered in the pass. This will
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
53 potential be extended to include verification using other external source
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
54 such as databases/api.
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
55
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
56 CSV File passed should be in the following format (Example):
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
57 position in H37Rv gene short name snp_type Reference Sample1 Sample2 Sample3
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
58 1285 dnaA dnaA1285 nsSNP G G G G
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
59 4013 recF recF4013 nsSNP T C C C
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
60
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
61 Report bugs to: combattb-help@sanbi.ac.za CombatTB home page:
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
62 <http://www.combattb.org/software/tools/> General help using CombatTB
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
63 software: <http://www.combattb.org/gethelp/>
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
64
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
65 Options:
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
66 --out TEXT set the output directory, default is
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
67 "/tmp/vcf_snps_utils_output/"
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
68 --help Show this message and exit.
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
69
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
70 vcf_snps_utils intersect example.vcf example.csv --out output/test
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
71
1
f8f16a682d01 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit cfb04d59b0377b23ddc1264ddcf8677f2b191aa8
sanbi-uwc
parents: 0
diff changeset
72 </help>
0
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
73
fc75be7f3fd2 planemo upload for repository https://github.com/COMBAT-TB/vcf_snps_utils commit a7c330a5dff63e78b9ff963a0b380937d27f4449
sanbi-uwc
parents:
diff changeset
74 </tool>