annotate vcfcheck.xml @ 3:dfe0b3d70972 draft

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