annotate vcfcheck.xml @ 3:e57a64775b9e draft default tip

Uploaded
author anton
date Mon, 15 Sep 2014 14:49:50 -0400
parents fb8033dcb750
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
fb8033dcb750 Updated tool version to 0.0.2
Anton Nekrutenko <anton@bx.psu.edu>
parents: 1
diff changeset
1 <tool id="vcfcheck" name="VCFcheck:" version="0.0.2">
0
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
2 <requirements>
3
e57a64775b9e Uploaded
anton
parents: 2
diff changeset
3 <requirement type="package" version="8a5602bf07">vcflib</requirement>
0
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
4 </requirements>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
5 <description>Verify that the reference allele matches the reference genome</description>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
6 <command>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
7 #set $reference_fasta_filename = "localref.fa"
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
8 #if str( $reference_source.reference_source_selector ) == "history":
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
9 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
10 #else:
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
11 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
12 #end if
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
13 vcfcheck $failure_selector -f "${reference_fasta_filename}" "${input_vcf}" > "${out_file1}"</command>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
14 <inputs>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
15 <conditional name="reference_source">
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
16 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
17 <option value="cached">Locally cached</option>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
18 <option value="history">History</option>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
19 </param>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
20 <when value="cached">
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
21 <param name="ref_file" type="select" label="Select reference genome">
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
22 <options from_data_table="fasta_indexes">
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
23 <!--<filter type="data_meta" key="dbkey" ref="input_bam" column="value"/>-->
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
24 </options>
42e3f0702878 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"/>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
26 </param>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
27 <param name="input_vcf" type="data" format="vcf" label="Select VCF dataset">
42e3f0702878 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
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
29 <validator type="unspecified_build" />
42e3f0702878 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." />
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
31 -->
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
32 </param>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
33 </when>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
34 <when value="history"> <!-- FIX ME!!!! -->
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
35 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
36 <param name="input_vcf" type="data" format="vcf" label="Select VCF dataset" />
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
37 </when>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
38 </conditional>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
39 <param name="failure_selector" type="select" display="radio" label="Exclude or include failed sites">
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
40 <option value="-x">Exculde failures (-x option)</option>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
41 <option value="-k">Keep failures (-k option)</option>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
42 </param>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
43 </inputs>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
44 <outputs>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
45 <data format="vcf" name="out_file1" />
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
46 </outputs>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
47 <stdio>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
48 <regex match="index file" source="stderr" level="warning"/>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
49 </stdio>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
50 <tests>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
51 <test>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
52 <param name="reference_source_selector" value="history" />
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
53 <param name="failure_selection" value="-x" />
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
54 <param name="input_vcf" value="vcflib-phix.vcf"/>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
55 <param name="ref_file" value="vcflib-test-genome-phix.fa" />
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
56 <output name="out_file1" file="vcfcheck-test1.vcf"/>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
57 </test>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
58 </tests>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
59 <help>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
60
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
61 Verifies that the VCF REF field matches the reference as described.
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
62
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
63 The options are::
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
64
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
65 -x, --exclude-failures If a record fails, don't print it. Otherwise do.
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
66 -k, --keep-failures Print if the record fails, otherwise not.
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
67
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
68 ----
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
69
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
70 Vcfcheck is a part of VCFlib toolkit developed by Erik Garrison (https://github.com/ekg/vcflib).
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
71
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
72 </help>
42e3f0702878 Imported from capsule None
anton
parents:
diff changeset
73 </tool>