annotate ClusterFast.xml @ 19:f51dd12f2263 draft

Uploaded
author geert-vandeweyer
date Mon, 28 Jul 2014 13:34:56 -0400
parents 6006459b580a
children 8a7011053512
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
d6cbbd19b09a Uploaded
geert-vandeweyer
parents: 4
diff changeset
1 <tool id="ClusterFast" name="ClusterFast" version="0611">
3
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
2 <description></description>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
3 <command interpreter="perl">
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
4 run_cf0611.pl
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
5
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
6 ## input files
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
7 -b $input1
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
8 -t $input2
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
9
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
10 ## references
9
2649dd253658 Uploaded
geert-vandeweyer
parents: 8
diff changeset
11 -p "${indexes.fields.path}"
3
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
12
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
13 ## output files
7
8cef32ac0486 Uploaded
geert-vandeweyer
parents: 5
diff changeset
14 -o $__new_file_path__ ## use galaxy temp dir for automatic cleanup.
3
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
15 -c $contigs
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
16 -y $bp1
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
17 -z $bp2
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
18
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
19
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
20 ## run parameters
8
4aca25ddadb0 Uploaded
geert-vandeweyer
parents: 7
diff changeset
21 -r 0 ## clean up not needed, as this is in galaxy tmp.
4
fda9f506e272 Uploaded
geert-vandeweyer
parents: 3
diff changeset
22 -m1 $m1
fda9f506e272 Uploaded
geert-vandeweyer
parents: 3
diff changeset
23 -m2 $m2
3
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
24 -d $distance
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
25 > $runlog
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
26 </command>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
27 <requirements>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
28 <requirement type="package" version="0.1.18">samtools</requirement>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
29 <requirement type="package" version="latest">novoalign</requirement>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
30 <requirement type="package" version="latest">velvet</requirement>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
31 <requirement type="package" version="latest">blat_server</requirement>
10
6006459b580a Uploaded
geert-vandeweyer
parents: 9
diff changeset
32 <requirement type="package" version="0611">clusterfast</requirement>
3
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
33 </requirements>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
34 <inputs>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
35 <param name="input1" type="data" format="bam" label="BAM file" help="BAM file of mapped reads." />
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
36 <param name="input2" type="data" format="bed" label="Target Regions BED" help="BED file containing regions of interest. See below for format" />
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
37 <param name="m1" type="integer" value="2" label="Supporting Discordant Read Pairs" help="Default: 2" />
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
38 <param name="m2" type="integer" value="1" label="Supporting Split Reads" help="Default: 1" />
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
39 <param name="distance" type="integer" value="50000" label="Max Distance From Target To Search" help="Default: 50000" />
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
40 <param name="indexes" type="select" label="Reference Genome" help="Select the correct genome build" >
9
2649dd253658 Uploaded
geert-vandeweyer
parents: 8
diff changeset
41 <options from_data_table="clusterfast" >
2649dd253658 Uploaded
geert-vandeweyer
parents: 8
diff changeset
42 <filter type="sort_by" column="2" />
2649dd253658 Uploaded
geert-vandeweyer
parents: 8
diff changeset
43 <validator type="no_options" message="No indexes are available" />
2649dd253658 Uploaded
geert-vandeweyer
parents: 8
diff changeset
44 </options>
3
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
45 </param>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
46 </inputs>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
47 <outputs>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
48 <data format="tabular" name="bp1" label="${tool.name} on ${on_string}: Primary Breakpoints"/>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
49 <data format="tabular" name="bp2" label="${tool.name} on ${on_string}: Final Breakpoints"/>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
50 <data format="txt" name="contigs" label="${tool.name} on ${on_string}: Contigs"/>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
51 <data format="txt" name="runlog" label="${tool.name} on ${on_string}: Runtime output"/>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
52 </outputs>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
53 <help>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
54
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
55 **What it does**
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
56
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
57 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
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
58
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
59 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.
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
60
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
61
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
62 ------
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
63
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
64 **Targets BED**
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
65
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
66 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::
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
67
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
68 Column 1: Chromosome : Use the same syntax as the references used by Galaxy. Check your sam-headers for the correct format. ('chr1' vs '1')
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
69 Column 2: Start Position
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
70 Column 3: End Position
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
71 Column 4: Target Name.
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
72 Column 5: Score : ignored, use '0'
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
73 Column 6: Strand: ,'+' or '-'
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
74
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
75
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
76 ------
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
77
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
78 **Input formats**
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
79
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
80 BAM file for reads, BED file for targets.
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
81
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
82 ------
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
83
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
84
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
85 </help>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
86 </tool>
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
87
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
88