annotate shear_sv.xml @ 4:a82400332451

Use shear_wrapper.py to generate reference indexes when needed
author Jim Johnson <jj@umn.edu>
date Tue, 16 Jul 2013 12:38:48 -0500
parents 630532975fa9
children aaaa5a071ff0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
1 <?xml version="1.0"?>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
2 <tool id="shear_sv" name="SHEAR-SV" version="0.0.1">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
3 <description>find SVs and estimate the heterogeneity levels from a BAM</description>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
4 <requirements>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
5 <requirement type="package" version="0.1.2">shear</requirement>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
6 <requirement type="package" version="0.1.18">samtools</requirement>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
7 <requirement type="package" version="0.6.2">bwa</requirement>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
8 <requirement type="package" version="1.0.1">crest</requirement>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
9 <requirement type="package" version="latest">kent</requirement>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
10 </requirements>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
11 <!--
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
12 <version_command></version_command>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
13 -->
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
14 <command interpreter="python">
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
15 shear_wrapper.py -j \$SHEAR_JAR_PATH/SHEAR.jar --command sv
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
16 -p $prefix
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
17 -b $bamfile
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
18 #if $genomeSource.refGenomeSource == 'indexed':
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
19 -f $genomeSource.ref_fastas.fields.path
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
20 -i $genomeSource.bwa_indices.fields.path
3
630532975fa9 Fix more typos
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
21 -t $genomeSource.twobit_indices.fields.path
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
22 #elif $genomeSource.refGenomeSource == 'svidx':
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
23 -f $genomeSource.svidx.extra_files_path/${genomeSource.svidx.metadata.base_name}.fa
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
24 -i $genomeSource.svidx.extra_files_path/${genomeSource.svidx.metadata.base_name}.fa
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
25 -t $genomeSource.svidx.extra_files_path/${genomeSource.svidx.metadata.base_name}.2bit
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
26 #else:
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
27 -f $genomeSource.ref_fasta
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
28 #if $genomeSource.save_svidx:
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
29 -D $sv_idx.extra_files_path
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
30 #end if
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
31 #end if
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
32 --report $report
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
33 --sdi $sdi
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
34 </command>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
35 <inputs>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
36 <param name="bamfile" type="data" format="bam" label="BAM alignment file containing the input sequences to the assembly."/>
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
37 <param name="prefix" type="text" value="shear_sv" label="Prefix for all generated files">
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
38 <validator type="regex" message="Prefix should start with a letter and contain only letter, digit, and '_' or '-' characters">[a-zA-Z0-9][_a-zA-Z0-9-]*</validator>
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
39 </param>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
40 <!-- reference data -->
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
41 <conditional name="genomeSource">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
42 <param name="refGenomeSource" type="select" label="Will you select a reference genome from your history or use a cached file?">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
43 <option value="indexed" selected="true">Use a cached reference genome</option>
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
44 <option value="history">Use fasta from the history</option>
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
45 <option value="svidx">Use SHEAR sv index from the history</option>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
46 </param>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
47 <when value="indexed">
1
a718ecb27e02 Comment out getting reference from history, need wrapper for that
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
48 <param name="ref_fastas" type="select" label="Select a reference genome fasta">
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
49 <options from_data_table="all_fasta">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
50 <filter type="sort_by" column="2" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
51 <validator type="no_options" message="No reference fasta files are available" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
52 </options>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
53 </param>
1
a718ecb27e02 Comment out getting reference from history, need wrapper for that
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
54 <param name="twobit_indices" type="select" label="Select the reference genome 2bit">
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
55 <options from_data_table="twobit">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
56 <filter type="sort_by" column="0" />
1
a718ecb27e02 Comment out getting reference from history, need wrapper for that
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
57 <!--
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
58 <filter type="data_meta" ref="ref_fastas" key="dbkey" column="0" />
1
a718ecb27e02 Comment out getting reference from history, need wrapper for that
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
59 -->
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
60 <validator type="no_options" message="No indexes are available" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
61 </options>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
62 </param>
1
a718ecb27e02 Comment out getting reference from history, need wrapper for that
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
63 <param name="bwa_indices" type="select" label="Select the reference genome bwa indices">
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
64 <options from_data_table="bwa_indexes">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
65 <filter type="sort_by" column="2" />
1
a718ecb27e02 Comment out getting reference from history, need wrapper for that
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
66 <!--
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
67 <filter type="data_meta" ref="ref_fastas" key="dbkey" column="0" />
1
a718ecb27e02 Comment out getting reference from history, need wrapper for that
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
68 -->
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
69 <validator type="no_options" message="No indexes are available" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
70 </options>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
71 </param>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
72 </when>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
73 <when value="history">
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
74 <param name="ref_fasta" type="data" format="fasta" label="Select a reference from history" />
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
75 <param name="save_svidx" type="boolean" truevalue="yes" falsevalue="no" label="Save sv generated reference indexes"/>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
76 </when>
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
77 <when value="svidx">
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
78 <param name="svidx" type="data" format="shear.svidx" label="Select a reference from history" />
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
79 </when>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
80 </conditional>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
81 </inputs>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
82 <stdio>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
83 <exit_code range="1:" level="fatal" description="Error" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
84 </stdio>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
85 <outputs>
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
86 <data format="shear.sdi" name="sdi" label="${tool.name} on ${on_string}: ${prefix}.sdi" />
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
87 <data format="txt" name="report" label="${tool.name} on ${on_string}: ${prefix}.report" />
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
88 <data format="shear.svidx" name="sv_idx" label="${tool.name} on ${on_string}: ${prefix}.svidx">
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
89 <filter>genomeSource['refGenomeSource'] == 'history' and genomeSource['save_svidx'] == True</filter>
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
90 </data>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
91 </outputs>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
92 <tests>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
93 <test>
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
94 <param name="prefix" value="shear_test" />
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
95 <param name="bamfile" value="simulated-data.bam" ftype="bam" />
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
96 <param name="refGenomeSource" value="history"/>
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
97 <param name="ref_fasta" value="syn.fa" ftype="fasta" />
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
98 <output name="sdi" file="shear_sv.sdi"/>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
99 <output name="report" file="shear_sv.report"/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
100 </test>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
101 </tests>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
102 <help>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
103 SHEAR-SV will process a BAM alignment file to find SVs and estimate the
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
104 heterogeneity level of those SVs. It will output a *.report file reporing the
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
105 SVs and their heterogeneity levels, and it will output a *.sdi file that can be
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
106 used for SHEAR-Assemble to reconstruct the new genome.
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
107 </help>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
108 </tool>