FusionSeq Requirements
From GersteinInfo
User documentation main
Contents |
Software Requirements
FusionSeq requires several additional packages to be installed in order to carry out the analysis and visualize the results. Moreover, since its modularity, different programs would need specific libraries. Moreover, some data sets are also required for the analysis (see Data Requirements). Here we describe the complete set of tools that one would need to run the analysis as we do in our lab. The modules should be installed in the listed order.
Note: the following instructions apply if one wants to compile FusionSeq from the source code (all versions). Alternatively, one can download the binaries (version 7.0 and later).
Alignment tools
- bowtie (64bit)
- Blat (source) (binaries)
Please make sure that blat and bowtie executables are part of the PATH, i.e. they can be accessed and executed from any location on your file system. Moreover, make sure that twoBitToFa is also downloaded from the blat package and part of the PATH.
Scientific and bioinformatics libraries
- GNU Scientific Library (GSL): this library is a required for the compilation of BIOS. As a reference, we tested FusionSeq with gsl-1.14.
(versions 0.7.0 and later)
- Starting with version 0.7.0, two new libraries are required:
Please note that this libraries are for the "early access" version of FusionSeq.
(versions up to 0.6.1)
- BIOS library: this library can be downloaded as part of RSEQtools, a computational framework to analyze RNA-Seq data, or it can be downloaded as a separate component from here.
Instructions to install GSL and BIOS (or libbios and libmrf -- depending on the version) can be found in Installation and Configuration of FusionSeq. However, please ensure that you read all the requirements (including Data requirements) and downloaded all the libraries and packages needed.
Drawing tools
- GD library: The gd library is used to create schematic images of the PE reads connecting the two genes. It is required by gfr2images, which is an optional component of FusionSeq. As a reference, we tested FusionSeq with gd-2.0.35.
Data analysis
- ROOT: this is a very powerful mathematical and computational framework. In the context of FusionSeq, it is used to perform a Kolomogorov-Smirnov analysis for filtering the breakpoint junctions and plotting the insert-size distribution.
Data Requirements
Here is the list of required data for a comprehensive use of FusionSeq tools.
External
- Homo Sapiens Reference genome (hg18): the user should download both chromFa.zip and hg18.2bit.
The human genome needs to be properly indexed to be used by bowtie. Please see the instruction of bowtie for performing this operation. Indicatevely, you would need to run something like:
$ bowtie-build -f hg18_nh.fa /path/to/bowtie/Index/hg18_nh/hg18_nh
where hg18_nh.fa corresponds to the concatenation of all human chromosomes from chromFa.zip without the different haplotypes and the "random" sequences.
Provided
The following data sets (for hg18), bundled in a tarball, can be downloaded here (hg18). For hg19 see below.
- knownGeneAnnotationTranscriptCompositeModel.txt - the interval file with the coordinates of the composite models
- knownGeneAnnotationTranscriptCompositeModel.fa - the sequences of all the composite transcripts
- kgXref.txt - the mapping between the UCSC knownGene annotation set and other information (RefSeq, gene symbols and description etc.)
- knownToTreefam.txt - the mapping between UCSC knownGene annotation and TreeFam
- hg18_repeatMasker.interval - the interval file, i.e. the file with the coordinates, of the repetitive regions
- ribosomal.2bit - the ribosomal sequences in 2bit format
The composite model needs to be indexed by bowtie:
$ bowtie-build -f knownGeneAnnotationTranscriptCompositeModel.fa /path/to/bowtie/Index/hg18_knownGeneAnnotationTranscriptCompositeModel/hg18_knownGeneAnnotationTranscriptCompositeModel
knownGeneAnnotationTranscriptCompositeModel.txt (the interval file) and knownGeneAnnotationTranscriptCompositeModel.fa (the sequences) should be located in the same directory.
Although we extensively used the UCSC knownGene annotation set, it is worth mentioning that it is possible to use other gene annotation sets. However, in this case, the same information, and in the same format, should be provided to the corresponding programs.
Human genome GRCh37/hg19
The corresponding version of these files for hg19 can be found here (hg19).
