annotate vcfgeno2haplo.xml @ 0:e19406b6e652

Imported from capsule None
author anton
date Wed, 11 Jun 2014 17:10:52 -0400
parents
children fee06b54bdd9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
1 <tool id="vcfgeno2haplo" name="VCFgenotype-to-haplotype:" version="0.0.1">
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
2 <requirements>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
3 <requirement type="package" version="586c5ae5d57a38dae6b32ea831fb1f7cfa14c9bd">vcflib</requirement>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
4 </requirements>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
5 <description>Convert genotype-based phased alleles into haplotype alleles</description>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
6 <command>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
7 #set $reference_fasta_filename = "localref.fa"
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
8 #if str( $reference_source.reference_source_selector ) == "history":
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
9 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
10 #else:
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
11 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
12 #end if
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
13 vcfgeno2haplo ${output_option} -w ${window_size} -r "${reference_fasta_filename}" "${input_vcf}" > "${out_file1}"</command>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
14 <inputs>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
15 <conditional name="reference_source">
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
16 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
17 <option value="cached">Locally cached</option>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
18 <option value="history">History</option>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
19 </param>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
20 <when value="cached">
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
21 <param name="ref_file" type="select" label="Select reference genome">
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
22 <options from_data_table="fasta_indexes">
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
23 <!--<filter type="data_meta" key="dbkey" ref="input_bam" column="value"/>-->
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
24 </options>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
25 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
26 </param>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
27 <param name="input_vcf" type="data" format="vcf" label="Select VCF dataset">
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
28 <!-- Validators are commented to allow users apply too to any build. May need to be revised in the future
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
29 <validator type="unspecified_build" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
30 <validator type="dataset_metadata_in_data_table" table_name="fasta_indexes" metadata_name="dbkey" metadata_column="1" message="Sequences are not currently available for the specified build." />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
31 -->
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
32 </param>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
33 </when>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
34 <when value="history"> <!-- FIX ME!!!! -->
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
35 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
36 <param name="input_vcf" type="data" format="vcf" label="Select VCF dataset" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
37 </when>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
38 </conditional>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
39 <param name="window_size" type="text" size="4" value="30" label="compare records up to this many bp away (window size)" help="--window-size option (default = 30)" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
40 <param name="output_option" type="boolean" truevalue="-o" falsevalue="" label="What to report?" help="--only-variants option" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
41 <!-- <option value=" ">Output entire haplotype</option>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
42 <option value="-o">Don't output the entire haplotype, just concatenate REF/ALT strings (delimited by &quot;:&quot;)</option>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
43 </param> -->
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
44 </inputs>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
45 <outputs>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
46 <data format="vcf" name="out_file1" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
47 </outputs>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
48 <stdio>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
49 <exit_code range="1:" level="fatal" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
50 </stdio>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
51 <tests>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
52 <test>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
53 <param name="reference_source_selector" value="history" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
54 <param name="output_option" value="true" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
55 <param name="window_size" value="5000" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
56 <param name="input_vcf" value="vcflib-phix.vcf"/>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
57 <param name="ref_file" value="vcflib-test-genome-phix.fa" />
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
58 <output name="out_file1" file="vcfgeno2haplo-test1.vcf"/>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
59 </test>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
60 </tests>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
61 <help>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
62
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
63 Convert genotype-based phased alleles within a window size specified by -w option into haplotype alleles. Will break haplotype construction when encountering non-phased genotypes on input.
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
64
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
65 The options are::
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
66
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
67 -r, --reference FILE FASTA reference file, required with -i and -u
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
68 -w, --window-size N Merge variants at most this many bp apart (default 30)
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
69 -o, --only-variants Don't output the entire haplotype, just concatenate
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
70 REF/ALT strings (delimited by ":")
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
71
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
72 ----
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
73
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
74 Vcfgeno2haplo is a part of VCFlib toolkit developed by Erik Garrison (https://github.com/ekg/vcflib).
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
75
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
76 </help>
e19406b6e652 Imported from capsule None
anton
parents:
diff changeset
77 </tool>