annotate README @ 4:679a5c7b1294 draft

deFuse version 0.5.0 - Use tool_dependencies.xml
author Jim Johnson <jj@umn.edu>
date Fri, 04 Jan 2013 13:29:03 -0600
parents 4245c2b047de
children 3bd1087db05e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
parents:
diff changeset
3
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
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.
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
parents:
diff changeset
5
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
parents:
diff changeset
6
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
parents:
diff changeset
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.
1
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
parents:
diff changeset
12
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
parents:
diff changeset
13
4
679a5c7b1294 deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 2
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.
679a5c7b1294 deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
15
679a5c7b1294 deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 2
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.
679a5c7b1294 deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
17 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
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.
679a5c7b1294 deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
19 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
20
679a5c7b1294 deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
21 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
22 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
23 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
24 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
25
1
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
parents:
diff changeset
26
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
27 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
28
4
679a5c7b1294 deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
29 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
30 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
31
4
679a5c7b1294 deFuse version 0.5.0 - Use tool_dependencies.xml
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
32 These datasets should be referenced in the tool-data/defuse.loc file.
1
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
parents:
diff changeset
33
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
parents:
diff changeset
34
36306d8086fa Remove defuse dir
Jim Johnson <jj@umn.edu>
parents:
diff changeset
35