annotate ClusterFast.xml @ 1:4a3afa90ff7f draft

Uploaded
author geert-vandeweyer
date Mon, 28 Jul 2014 05:53:55 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
1 <tool id="ClusterFast" name="ClusterFast" version="0.0.1">
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
2 <description></description>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
3 <command interpreter="perl">
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
4 run_cf0611.pl
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
5
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
6 ## input files
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
7 -b $input1
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
8 -t $input2
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
9
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
10 ## references
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
11 -p $indexes
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
12
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
13 ## output files
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
14 -o $__new_file_path__ # use galaxy temp dir for automatic cleanup.
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
15 -c $contigs
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
16 -y $bp1
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
17 -z $bp2
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
18
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
19
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
20 ## run parameters
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
21 -r O ## clean up not needed, as this is in galaxy tmp.
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
22 -m1 $discordant
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
23 -m2 $split
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
24 -d $distance
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
25 > $runlog
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
26 </command>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
27 <requirements>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
28 <requirement type="package" version="0.1.18">samtools</requirement>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
29 <requirement type="package" version="3.02.07">novoalign</requirement>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
30 <requirement type="package" version="1.2.10">velvet</requirement>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
31 <requirement type="package" version="latest">blat_server</requirement>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
32 </requirements>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
33 <inputs>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
34 <param name="input1" type="data" format="bam" label="BAM file" help="BAM file of mapped reads." />
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
35 <param name="input2" type="data" format="bed" label="Target Regions BED" help="BED file containing regions of interest. See below for format" />
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
36 <param name="m1" type="integer" value="2" label="Supporting Discordant Read Pairs" help="Default: 2" />
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
37 <param name="m2" type="integer" value="1" label="Supporting Split Reads" help="Default: 1" />
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
38 <param name="distance" type="integer" value="50000" label="Max Distance From Target To Search" help="Default: 50000" />
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
39 <param name="indexes" type="select" label="Reference Genome" help="Select the correct genome build" >
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
40 <options from_data_table="clusterfast" />
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
41 </param>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
42 </inputs>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
43 <outputs>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
44 <data format="tabular" name="bp1" label="${tool.name} on ${on_string}: Primary Breakpoints"/>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
45 <data format="tabular" name="bp2" label="${tool.name} on ${on_string}: Final Breakpoints"/>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
46 <data format="txt" name="contigs" label="${tool.name} on ${on_string}: Contigs"/>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
47 <data format="txt" name="runlog" label="${tool.name} on ${on_string}: Runtime output"/>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
48 </outputs>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
49 <help>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
50
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
51 **What it does**
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
52
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
53 ClusterFAST is a tool for finding translocation in next generation sequencing data developed by Haley Abel and Eric Duncavage at Washington University in St. Louis, MO. A manuscript detailing the use of ClusterFAST ican be found at: http://www.ncbi.nlm.nih.gov/pubmed/?term=24813172. For questions or comments please email eduncavage@path.wustl.edu
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
54
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
55 ClusterFAST is a pipeline for highly specific detection of translocations from high-coverage targeted capture sequence data. It detects translocation breakpoints with single base accuracy and provides assembled contigs for PCR validation. ClustFAST is implemented in Java for improved interoperability and can be run from the command line via a perl script. ClusterFAST is meant for translocation detection from targeted regions and requires a picard-style interval file containing the targets (e.g., ALK_MLL.txt). Numerous output files are created during the workflow (see below) to allow for error checking. The current version of ClusterFAST uses velvet to assemble contigs during the final step, however other assemblers can be substituted.
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
56
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
57
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
58 ------
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
59
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
60 **Targets BED**
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
61
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
62 The BED file containing targets of interest. I would recommend to use one entry per gene of interest, instead of one entry per exon for this tool::
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
63
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
64 Column 1: Chromosome : Use the same syntax as the references used by Galaxy. Check your sam-headers for the correct format. ('chr1' vs '1')
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
65 Column 2: Start Position
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
66 Column 3: End Position
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
67 Column 4: Target Name.
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
68 Column 5: Score : ignored, use '0'
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
69 Column 6: Strand: ,'+' or '-'
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
70
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
71
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
72 ------
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
73
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
74 **Input formats**
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
75
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
76 BAM file for reads, BED file for targets.
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
77
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
78 ------
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
79
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
80
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
81 </help>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
82 </tool>
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
83
4a3afa90ff7f Uploaded
geert-vandeweyer
parents:
diff changeset
84