annotate shear_sv.xml @ 0:ea76da1e7281

Uploaded
author jjohnson
date Fri, 05 Jul 2013 15:22:04 -0400
parents
children a718ecb27e02
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 -->
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
14 <command>java -jar \$SHEAR_JAR_PATH/SHEAR.jar sv -r $prefix
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
15 -b $bamfile
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
16 #if $genomeSource.refGenomeSource == 'indexed':
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
17 -f $genomeSource.ref_fastas.fields.path
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
18 -i $genomeSource.bwa_indices.fields.path
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
19 -t $genomeSource.twobit_indice.fields.paths
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
20 #else:
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
21 -f $genomeSource.ref_fasta
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
22 -i $genomeSource.bwa_index
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
23 -t $genomeSource.twobit
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
24 #end if
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
25 </command>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
26 <inputs>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
27 <param name="bamfile" type="data" format="bam" label="BAM alignment file containing the input sequences to the assembly."/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
28 <!-- reference data -->
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
29 <conditional name="genomeSource">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
30 <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
31 <option value="indexed" selected="true">Use a cached reference genome</option>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
32 <option value="history">Use one from the history</option>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
33 </param>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
34 <when value="indexed">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
35 <param name="ref_fastas" type="select" label="Select a reference genome">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
36 <options from_data_table="all_fasta">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
37 <filter type="sort_by" column="2" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
38 <validator type="no_options" message="No reference fasta files are available" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
39 </options>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
40 </param>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
41 <param name="twobit_indices" type="select" label="Select a reference genome">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
42 <options from_data_table="twobit">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
43 <filter type="sort_by" column="0" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
44 <filter type="data_meta" ref="ref_fastas" key="dbkey" column="0" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
45 <validator type="no_options" message="No indexes are available" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
46 </options>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
47 </param>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
48 <param name="bwa_indices" type="select" label="Select a reference genome">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
49 <options from_data_table="bwa_indexes">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
50 <filter type="sort_by" column="2" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
51 <filter type="data_meta" ref="ref_fastas" key="dbkey" column="0" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
52 <validator type="no_options" message="No indexes are available" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
53 </options>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
54 </param>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
55 </when>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
56 <when value="history">
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
57 <param name="ref_fasta" type="data" format="fasta" metadata_name="dbkey" label="Select a reference from history" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
58 <param name="twobit" type="data" format="twobit" metadata_name="dbkey" label="Select a reference from history" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
59 <param name="bwa_index" type="data" format="fasta" metadata_name="dbkey" label="Select a reference from history" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
60 </when>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
61 </conditional>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
62 <param name="prefix" type="hidden" value="shear_sv" label="Prefix for all generated files"/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
63 </inputs>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
64 <stdio>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
65 <exit_code range="1:" level="fatal" description="Error" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
66 </stdio>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
67 <outputs>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
68 <data format="shear.sdi" name="sdi" label="${tool.name} on ${on_string}: shear_sv.sdi" from_work_dir="shear_sv.sdi" />
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
69 <data format="txt" name="report" label="${tool.name} on ${on_string}: shear_sv.report" from_work_dir="shear_sv.report"/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
70 </outputs>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
71 <tests>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
72 <test>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
73 <param name="bamfile" ftype="bam" value="simulated-data.bam"/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
74 <param name="refGenomeSource" value="history"/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
75 <param name="ref_fasta" ftype="fasta" value="syn.fa"/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
76 <param name="bwa_index" ftype="" value="syn.fa"/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
77 <param name="twobit" ftype="twobit" value="syn.2bit"/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
78 <output name="shear.sdi" file="shear_sv.sdi"/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
79 <output name="report" file="shear_sv.report"/>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
80 </test>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
81 </tests>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
82 <help>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
83 SHEAR-SV will process a BAM alignment file to find SVs and estimate the
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
84 heterogeneity level of those SVs. It will output a *.report file reporing the
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
85 SVs and their heterogeneity levels, and it will output a *.sdi file that can be
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
86 used for SHEAR-Assemble to reconstruct the new genome.
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
87 </help>
ea76da1e7281 Uploaded
jjohnson
parents:
diff changeset
88 </tool>