annotate vcfhethom.xml @ 0:586d614a4c2d draft

Uploaded
author devteam
date Thu, 19 Mar 2015 14:40:35 -0400
parents
children c9bb9f126282
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
586d614a4c2d Uploaded
devteam
parents:
diff changeset
1 <tool id="vcfhethom" name="VCFhetHomAlleles:" version="0.0.3">
586d614a4c2d Uploaded
devteam
parents:
diff changeset
2 <description>Count the number of heterozygotes and alleles, compute het/hom ratio</description>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
3 <macros>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
4 <import>macros.xml</import>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
5 </macros>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
6 <expand macro="requirements"></expand>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
7 <expand macro="stdio" />
586d614a4c2d Uploaded
devteam
parents:
diff changeset
8 <command>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
9
586d614a4c2d Uploaded
devteam
parents:
diff changeset
10 #if str($analysis_type) == "count":
586d614a4c2d Uploaded
devteam
parents:
diff changeset
11 vcfhetcount "${vcf_input}" > "${out_file1}"
586d614a4c2d Uploaded
devteam
parents:
diff changeset
12 #elif str($analysis_type) == "ratio":
586d614a4c2d Uploaded
devteam
parents:
diff changeset
13 vcfhethomratio "${vcf_input}" > "${out_file1}"
586d614a4c2d Uploaded
devteam
parents:
diff changeset
14 #elif str($analysis_type) == "allele_count":
586d614a4c2d Uploaded
devteam
parents:
diff changeset
15 vcfcountalleles "${vcf_input}" > "${out_file1}"
586d614a4c2d Uploaded
devteam
parents:
diff changeset
16 #end if
586d614a4c2d Uploaded
devteam
parents:
diff changeset
17
586d614a4c2d Uploaded
devteam
parents:
diff changeset
18 </command>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
19
586d614a4c2d Uploaded
devteam
parents:
diff changeset
20 <inputs>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
21 <param name="analysis_type" type="select" display="radio" label="Select type of calculation:">
586d614a4c2d Uploaded
devteam
parents:
diff changeset
22 <option value="count">Compute the number of heterozygotes</option>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
23 <option value="ratio">Compute the ratio between heterozygotes and homozygotes</option>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
24 <option value="allele_count">Compute the total number of alleles</option>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
25 </param>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
26 <param format="vcf" name="vcf_input" type="data" label="In this VCF dataset"/>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
27 </inputs>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
28 <outputs>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
29 <data format="tabular" name="out_file1" />
586d614a4c2d Uploaded
devteam
parents:
diff changeset
30 </outputs>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
31 <tests>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
32 <test>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
33 <param name="analysis_type" value="count"/>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
34 <param name="vcf_input" value="vcflib.vcf"/>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
35 <output name="out_file1" file="vcfhethom-test1.tab"/>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
36 </test>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
37 <test>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
38 <param name="analysis_type" value="ratio"/>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
39 <param name="vcf_input" value="vcflib.vcf"/>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
40 <output name="out_file1" file="vcfhethom-test2.tab"/>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
41 </test>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
42 <test>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
43 <param name="analysis_type" value="allele_count"/>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
44 <param name="vcf_input" value="vcflib.vcf"/>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
45 <output name="out_file1" file="vcfhethom-test3.tab"/>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
46 </test>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
47 </tests>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
48 <help>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
49
586d614a4c2d Uploaded
devteam
parents:
diff changeset
50 This tool performs three basic calculations:
586d614a4c2d Uploaded
devteam
parents:
diff changeset
51
586d614a4c2d Uploaded
devteam
parents:
diff changeset
52 (1) Computes the number of heterozygotes
586d614a4c2d Uploaded
devteam
parents:
diff changeset
53 (2) Computes the ratio between heterozygotes and homozygotes
586d614a4c2d Uploaded
devteam
parents:
diff changeset
54 (3) Computes the total number of alleles in the input dataset
586d614a4c2d Uploaded
devteam
parents:
diff changeset
55
586d614a4c2d Uploaded
devteam
parents:
diff changeset
56 ----
586d614a4c2d Uploaded
devteam
parents:
diff changeset
57
586d614a4c2d Uploaded
devteam
parents:
diff changeset
58 This tools is based on vcfhetcount, vcfhethomratio,and vcfcountalleles utilities from the VCFlib toolkit developed by Erik Garrison (https://github.com/ekg/vcflib).
586d614a4c2d Uploaded
devteam
parents:
diff changeset
59
586d614a4c2d Uploaded
devteam
parents:
diff changeset
60 </help>
586d614a4c2d Uploaded
devteam
parents:
diff changeset
61 <expand macro="citations" />
586d614a4c2d Uploaded
devteam
parents:
diff changeset
62 </tool>