annotate README @ 2:60a83037fd82

Fix faToTwoBit name
author Jim Johnson <jj@umn.edu>
date Fri, 04 Jan 2013 13:11:04 -0600
parents b75ea9927793
children ffc5e442c1ca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
1 The DeFuse galaxy tool is based on DeFuse_Version_0.5.0
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
2 http://sourceforge.net/apps/mediawiki/defuse/index.php?title=Main_Page
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
3
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
4 DeFuse is a software package for gene fusion discovery using RNA-Seq data. The software uses clusters of discordant paired end alignments to inform a split read alignment analysis for finding fusion boundaries. The software also employs a number of heuristic filters in an attempt to reduce the number of false positives and produces a fully annotated output for each predicted fusion.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
5
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
6
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
7 Manual:
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
8 http://sourceforge.net/apps/mediawiki/defuse/index.php?title=DeFuse_Version_0.4.2
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
9
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
10 The included tool_dependencies.xml will download and install the defuse code.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
11 It will set the environment variable: "DEFUSE_PATH" to the location of the defuse install.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
12
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
13
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
14 The defuse.pl command relies on a configuration file to specifiy options, the location of reference data, and other applications that it depends upon: bowtie, bowtie-build, samtools, blat, fatotwobit, R, and Rscript.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
15
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
16 The DeFuse galaxy tool can either construct the config.txt file that is mentioned in the defuse manual, or select an existing config.txt file in the users history.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
17 When constructing the config.txt file, the DeFuse tool uses the values selected in: tool-data/defuse.loc
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
18 The dictionary field in the tool-data/defuse.loc can be used to set fields in the config.txt file, including the site specific location of reference data and the paths to the other application binaries.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
19 The "Defuse parameter settings" are used to alter options in the config.txt file.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
20
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
21 The DeFuse galaxy tool also generates a bash script to run defuse.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
22 That script will attempt to edit the config.txt file to specifiy any unset paths to applications that defuse relies upon:
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
23 bowtie, bowtie-build, samtools, blat, fatotwobit, R, and Rscript
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
24 The script uses the using the shell "which" command to discover the application path, so the required applications should in PATH environment variable.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
25
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
26
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
27 Generate Reference Datasets as described in the Manual:
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
28
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
29 The manual has detailed instructions on how to set up reference datasets for Human hg19 and hg18.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
30 We were able to follow the same basic procedures to set up a reference for Mouse mm9.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
31
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
32 These datasets should be referenced in the tool-data/defuse.loc file.
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
33
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
34
b75ea9927793 Uploaded
jjohnson
parents:
diff changeset
35