Mercurial > repos > jjohnson > defuse
annotate README @ 6:6e30713cefb0 draft
Edit labels and help.
| author | Jim Johnson <jj@umn.edu> |
|---|---|
| date | Mon, 07 Jan 2013 14:49:50 -0600 |
| parents | 3bd1087db05e |
| children | 1ea6445491d4 |
| rev | line source |
|---|---|
|
4
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
1 The DeFuse galaxy tool is based on DeFuse_Version_0.5.0 |
|
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: | |
|
4
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
8 http://sourceforge.net/apps/mediawiki/defuse/index.php?title=DeFuse_Version_0.4.2 |
|
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 | |
|
4
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
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, blat, fatotwobit, R, and Rscript. |
|
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 |
|
4
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
30 The manual has detailed instructions on how to set up reference datasets for Human hg19 and hg18. |
|
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
31 We were able to follow the same basic procedures to set up a reference for Mouse mm9. |
|
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
|
32 |
|
4
679a5c7b1294
deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents:
2
diff
changeset
|
33 These datasets should be referenced in the tool-data/defuse.loc file. |
| 1 | 34 |
| 35 | |
|
5
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
36 External Tools |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
37 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. |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
38 Download bowtie: |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
39 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
|
40 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
|
41 Download blat and faToTwoBit |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
42 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. |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
43 Download R |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
44 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. |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
45 Install the kernlab package. Run R, then at the prompt type install.packages("kernlab") |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
46 Creating required derivative files |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
47 Once the required files and tools have been downloaded, the create_reference_dataset.pl script will build any derivative files including bowtie indices and 2bit files. Run the following command. Expect this step to take at least 12 hours. |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
48 create_reference_dataset.pl -c config.txt |
| 1 | 49 |
|
5
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
50 |
|
3bd1087db05e
Add dependecies for bowtie, blat, and faToTwoBit
Jim Johnson <jj@umn.edu>
parents:
4
diff
changeset
|
51 |