annotate shear_sv.xml @ 7:8180f6b0249b

Upgrade to SHEAR version 0.2.4
author Jim Johnson <jj@umn.edu>
date Tue, 22 Oct 2013 08:20:52 -0500
parents 0158f7356ffd
children 03071ff2e5c9
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"?>
7
8180f6b0249b Upgrade to SHEAR version 0.2.4
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
2 <tool id="shear_sv" name="SHEAR-SV" version="0.0.3">
0
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>
7
8180f6b0249b Upgrade to SHEAR version 0.2.4
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
5 <requirement type="package" version="0.2.4">shear</requirement>
0
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
6
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
16 -p $prefix ## used in gerenating ouput file names
4
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
6
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
32 #if $region and $region.__str__.strip() != '':
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
33 -r $region
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
34 #end if
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
35 $sv_only
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
36 </command>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
37 <inputs>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
38 <param name="bamfile" type="data" format="bam" label="BAM alignment file containing the input sequences to the assembly."/>
6
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
39 <param name="prefix" type="hidden" value="shear_sv" label="Prefix for all generated files"/>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
40 <!--
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
41 <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
42 <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
43 </param>
6
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
44 -->
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
45 <!-- reference data -->
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
46 <conditional name="genomeSource">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
47 <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
48 <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
49 <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
50 <option value="svidx">Use SHEAR sv index from the history</option>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
51 </param>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
52 <when value="indexed">
1
a718ecb27e02 Comment out getting reference from history, need wrapper for that
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
53 <param name="ref_fastas" type="select" label="Select a reference genome fasta">
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
54 <options from_data_table="all_fasta">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
55 <filter type="sort_by" column="2" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
56 <validator type="no_options" message="No reference fasta files are available" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
57 </options>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
58 </param>
1
a718ecb27e02 Comment out getting reference from history, need wrapper for that
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
59 <param name="twobit_indices" type="select" label="Select the reference genome 2bit">
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
60 <options from_data_table="twobit">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
61 <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
62 <!--
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
63 <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
64 -->
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
65 <validator type="no_options" message="No indexes are available" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
66 </options>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
67 </param>
1
a718ecb27e02 Comment out getting reference from history, need wrapper for that
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
68 <param name="bwa_indices" type="select" label="Select the reference genome bwa indices">
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
69 <options from_data_table="bwa_indexes">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
70 <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
71 <!--
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
72 <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
73 -->
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
74 <validator type="no_options" message="No indexes are available" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
75 </options>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
76 </param>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
77 </when>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
78 <when value="history">
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
79 <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
80 <param name="save_svidx" type="boolean" truevalue="yes" falsevalue="no" label="Save sv generated reference indexes"/>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
81 </when>
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
82 <when value="svidx">
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
83 <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
84 </when>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
85 </conditional>
6
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
86 <param name="region" type="text" value="" optional="true" label="Region of the input alignment to analyze">
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
87 <help>"chr1" for full chromosome or "chr1:10000-15000" for a particular region, including endpoints).
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
88 Coordinates are 1-based.
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
89 </help>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
90 <validator type="regex" message="format: chr1:100-200">^\w+(:\d+-\d+)?$</validator>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
91 </param>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
92 <param name="sv_only" type="boolean" truevalue="--sv-only" falsevalue="" checked="false" label="SV Only prediction mode."
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
93 help="Will skip SNP/INDEL prediction and only return *.sdi and *.report results for SVs."/>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
94 </inputs>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
95 <stdio>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
96 <exit_code range="1:" level="fatal" description="Error" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
97 </stdio>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
98 <outputs>
6
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
99 <data format="txt" name="report_snpindel" label="${tool.name} on ${on_string}: ${prefix}.snpindel.report" from_work_dir="shear_sv.snpindel.report">
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
100 <filter>sv_only == False</filter>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
101 </data>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
102 <data format="txt" name="report_sv" label="${tool.name} on ${on_string}: ${prefix}.sv.report" from_work_dir="shear_sv.sv.report"/>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
103 <data format="txt" name="report_all" label="${tool.name} on ${on_string}: ${prefix}.all.report" from_work_dir="shear_sv.all.report">
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
104 <filter>sv_only == False</filter>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
105 </data>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
106 <data format="shear.sdi" name="sdi_snpindel" label="${tool.name} on ${on_string}: ${prefix}.snpindel.sdi" from_work_dir="shear_sv.snpindel.sdi">
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
107 <filter>sv_only == False</filter>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
108 </data>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
109 <data format="shear.sdi" name="sdi_sv" label="${tool.name} on ${on_string}: ${prefix}.sv.sdi" from_work_dir="shear_sv.sv.sdi"/>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
110 <data format="shear.sdi" name="sdi_all" label="${tool.name} on ${on_string}: ${prefix}.all.sdi" from_work_dir="shear_sv.all.sdi">
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
111 <filter>sv_only == False</filter>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
112 </data>
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
113 <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
114 <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
115 </data>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
116 </outputs>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
117 <tests>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
118 <test>
4
a82400332451 Use shear_wrapper.py to generate reference indexes when needed
Jim Johnson <jj@umn.edu>
parents: 3
diff changeset
119 <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
120 <param name="bamfile" value="simulated-data.bam" ftype="bam" />
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
121 <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
122 <param name="ref_fasta" value="syn.fa" ftype="fasta" />
6
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
123 <param name="save_svidx" value="false"/>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
124 <param name="sv_only" value="true"/>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
125 <output name="sdi_sv" file="shear_sv.sdi"/>
0158f7356ffd Add new outputs and params to shear_sv.xml for version 2.3
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
126 <output name="report_sv" file="shear_sv.report"/>
0
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
127 </test>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
128 </tests>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
129 <help>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
130 SHEAR-SV will process a BAM alignment file to find SVs and estimate the
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
131 heterogeneity level of those SVs. It will output a *.report file reporing the
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
132 SVs and their heterogeneity levels, and it will output a *.sdi file that can be
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
133 used for SHEAR-Assemble to reconstruct the new genome.
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
134 </help>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
135 </tool>