Mercurial > repos > jjohnson > defuse
annotate README @ 10:f65857c1b92e draft
Escape $ to correct cheetah error
| author | Jim Johnson <jj@umn.edu> |
|---|---|
| date | Mon, 14 Jan 2013 12:24:28 -0600 |
| parents | 1ea6445491d4 |
| children | b22f8634ff84 |
| rev | line source |
|---|---|
| 7 | 1 The DeFuse galaxy tool is based on DeFuse_Version_0.6.0 |
|
4
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
2 http://sourceforge.net/apps/mediawiki/defuse/index.php?title=Main_Page |
| 1 | 3 |
| 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. | |
| 5 | |
| 6 | |
| 7 Manual: | |
| 7 | 8 http://sourceforge.net/apps/mediawiki/defuse/index.php?title=DeFuse_Version_0.6.0 |
|
4
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
9 |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
10 The included tool_dependencies.xml will download and install the defuse code. |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
11 It will set the environment variable: "DEFUSE_PATH" to the location of the defuse install. |
|
5
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
12 The tool_dependencies.xml also has the download for bowtie. |
| 1 | 13 |
| 14 | |
| 7 | 15 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, gmap, blat, fatotwobit, R, and Rscript. |
|
4
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
16 |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
17 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. |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
18 When constructing the config.txt file, the DeFuse tool uses the values selected in: tool-data/defuse.loc |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
19 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. |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
20 The "Defuse parameter settings" are used to alter options in the config.txt file. |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
21 |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
22 The DeFuse galaxy tool also generates a bash script to run defuse. |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
23 That script will attempt to edit the config.txt file to specifiy any unset paths to applications that defuse relies upon: |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
24 bowtie, bowtie-build, samtools, blat, fatotwobit, R, and Rscript |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
25 The script uses the using the shell "which" command to discover the application path, so the required applications should in PATH environment variable. |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
26 |
| 1 | 27 |
|
2
4245c2b047de
Changes for defuse-0.4.3, modifications for non-human genomes no longer required, defuse.xml searches for location of scripts/defuse.pl
Jim Johnson <jj@umn.edu>
parents:
1
diff
changeset
|
28 Generate Reference Datasets as described in the Manual: |
|
4245c2b047de
Changes for defuse-0.4.3, modifications for non-human genomes no longer required, defuse.xml searches for location of scripts/defuse.pl
Jim Johnson <jj@umn.edu>
parents:
1
diff
changeset
|
29 |
| 7 | 30 Reference Dataset |
| 31 The reference dataset setup process has been simplified as of deFuse 0.6.0, and deFuse now automatically downloads all required files. | |
| 32 The create_reference_dataset.pl script will download the genome and other source files, and build any derivative files including bowtie indices, gmap indices, and 2bit files. Run the following command. Expect this step to take at least 12 hours. | |
| 33 create_reference_dataset.pl -c config.txt | |
|
2
4245c2b047de
Changes for defuse-0.4.3, modifications for non-human genomes no longer required, defuse.xml searches for location of scripts/defuse.pl
Jim Johnson <jj@umn.edu>
parents:
1
diff
changeset
|
34 |
|
4
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
35 These datasets should be referenced in the tool-data/defuse.loc file. |
| 1 | 36 |
| 37 | |
| 7 | 38 External Tools ( http://sourceforge.net/apps/mediawiki/defuse/index.php?title=DeFuse_Version_0.6.0 ) |
|
5
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
39 deFuse relies on other publically available tools as part of its pipeline. Some of these tools are not included with the deFuse download. Obtain these tools as detailed below. |
| 7 | 40 Download samtools |
| 41 The latest version of samtools can be downloaded from sourceforge: https://sourceforge.net/projects/samtools/files/samtools. | |
| 42 Set the samtools_bin entry in config.txt to the fully qualified paths of the samtools binary. | |
| 43 Download bowtie | |
|
5
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
44 The latest version of bowtie can be downloaded from sourceforge: http://sourceforge.net/projects/bowtie-bio/files/bowtie/. deFuse has been tested on version 0.12.5. |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
45 Set the bowtie_bin and bowtie_build_bin entries in config.txt to the fully qualified paths of the bowtie and bowtie-build binaries. |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
46 Download blat and faToTwoBit |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
47 The latest blat tool suite can be downloaded from the ucsc website: http://hgdownload.cse.ucsc.edu/admin/exe/. Download blat and faToTwoBit and set the blat_bin and fatotwobit_bin entries in config.txt to the fully qualified paths of the blat and faToTwoBit binaries. |
| 7 | 48 Download GMAP |
| 49 The latest version of GMAP can be downloaded here http://research-pub.gene.com/gmap/. Build with a default configuration. Do not worry about the `--with-gmapdb` build flag, deFuse will request a specific directory for the database anyway. | |
|
5
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
50 Download R |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
51 The latest version of R can be downloaded from the R project website: http://www.r-project.org/. Install R and then locate the R and Rscript executables, and set the r_bin and rscript_bin entries in config.txt to the path of those executables. |
| 7 | 52 Install the ada package. Run R, then at the prompt type install.packages("ada") |
| 53 Reference Dataset | |
| 54 The reference dataset setup process has been simplified as of deFuse 0.6.0, and deFuse now automatically downloads all required files. | |
| 55 The create_reference_dataset.pl script will download the genome and other source files, and build any derivative files including bowtie indices, gmap indices, and 2bit files. Run the following command. Expect this step to take at least 12 hours. | |
|
5
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
56 create_reference_dataset.pl -c config.txt |
| 1 | 57 |