README.md

   1 README for RSEM
   2 ===============
   3
   4 [Bo Li](http://pages.cs.wisc.edu/~bli) \(bli at cs dot wisc dot edu\)
   5
   6 * * *
   7
   8 Table of Contents
   9 -----------------
  10
  11 * [Introduction](#introduction)
  12 * [Compilation & Installation](#compilation)
  13 * [Usage](#usage)
  14 * [Example](#example)
  15 * [Simulation](#simulation)
  16 * [Acknowledgements](#acknowledgements)
  17 * [License](#license)
  18
  19 * * *
  20
  21 ## <a name="introduction"></a> Introduction
  22
  23 RSEM is a software package for estimating gene and isoform expression
  24 levels from RNA-Seq data.  The new RSEM package (rsem-1.x) provides an
  25 user-friendly interface, supports threads for parallel computation of
  26 the EM algorithm, single-end and paired-end read data, quality scores,
  27 variable-length reads and RSPD estimation. It can also generate
  28 genomic-coordinate BAM files and UCSC wiggle files for visualization. In
  29 addition, it provides posterior mean and 95% credibility interval
  30 estimates for expression levels.
  31
  32 ## <a name="compilation"></a> Compilation & Installation
  33
  34 To compile RSEM, simply run
  35
  36     make
  37
  38 To install, simply put the rsem directory in your environment's PATH
  39 variable.
  40
  41 ### Prerequisites
  42
  43 C++ and Perl are required to be installed.
  44
  45 To take advantage of RSEM's built-in support for the Bowtie alignment
  46 program, you must have [Bowtie](http://bowtie-bio.sourceforge.net) installed.
  47
  48 If you want to plot model learned by RSEM, you should also install R.
  49
  50 ## <a name="usage"></a> Usage
  51
  52 ### I. Preparing Reference Sequences
  53
  54 RSEM can extract reference transcripts from a genome if you provide it
  55 with gene annotations in a GTF file.  Alternatively, you can provide
  56 RSEM with transcript sequences directly.
  57
  58 Please note that GTF files generated from the UCSC Table Browser do not
  59 contain isoform-gene relationship information.  However, if you use the
  60 UCSC Genes annotation track, this information can be recovered by
  61 downloading the knownIsoforms.txt file for the appropriate genome.
  62
  63 To prepare the reference sequences, you should run the
  64 'rsem-prepare-reference' program.  Run
  65
  66     rsem-prepare-reference --help
  67
  68 to get usage information or visit the [rsem-prepare-reference
  69 documentation page](http://deweylab.biostat.wisc.edu/rsem/rsem-prepare-reference.html).
  70
  71 ### II. Calculating Expression Values
  72
  73 To calculate expression values, you should run the
  74 'rsem-calculate-expression' program.  Run
  75
  76     rsem-calculate-expression --help
  77
  78 to get usage information or visit the [rsem-calculate-expression
  79 documentation page](http://deweylab.biostat.wisc.edu/rsem/rsem-calculate-expression.html).
  80
  81 #### Calculating expression values from single-end data
  82
  83 For single-end models, users have the option of providing a fragment
  84 length distribution via the --fragment-length-mean and
  85 --fragment-length-sd options.  The specification of an accurate fragment
  86 length distribution is important for the accuracy of expression level
  87 estimates from single-end data.  If the fragment length mean and sd are
  88 not provided, RSEM will not take a fragment length distribution into
  89 consideration.
  90
  91 #### Using an alternative aligner
  92
  93 By default, RSEM automates the alignment of reads to reference
  94 transcripts using the Bowtie alignment program.  To use an alternative
  95 alignment program, align the input reads against the file
  96 'reference_name.idx.fa' generated by rsem-prepare-reference, and format
  97 the alignment output in SAM or BAM format.  Then, instead of providing
  98 reads to rsem-calculate-expression, specify the --sam or --bam option
  99 and provide the SAM or BAM file as an argument.  When using an
 100 alternative aligner, you may also want to provide the --no-bowtie option
 101 to rsem-prepare-reference so that the Bowtie indices are not built.
 102
 103 ### III. Visualization
 104
 105 RSEM contains a version of samtools in the 'sam' subdirectory. When
 106 users specify the --out-bam option RSEM will produce three files:
 107 'sample_name.bam', the unsorted BAM file, 'sample_name.sorted.bam' and
 108 'sample_name.sorted.bam.bai' the sorted BAM file and indices generated
 109 by the samtools included.
 110
 111 #### a) Generating a UCSC Wiggle file
 112
 113 A wiggle plot representing the expected number of reads overlapping
 114 each position in the genome can be generated from the sorted BAM file
 115 output.  To generate the wiggle plot, run the 'rsem-bam2wig' program on
 116 the 'sample_name.sorted.bam' file.
 117
 118 Usage:
 119
 120     rsem-bam2wig bam_input wig_output wiggle_name
 121
 122 bam_input: sorted bam file
 123 wig_output: output file name, e.g. output.wig
 124 wiggle_name: the name the user wants to use for this wiggle plot
 125
 126 #### b) Loading a BAM and/or Wiggle file into the UCSC Genome Browser
 127
 128 Refer to the [UCSC custom track help page](http://genome.ucsc.edu/goldenPath/help/customTrack.html).
 129
 130 #### c) Visualize the model learned by RSEM
 131
 132 RSEM provides an R script, 'rsem-plot-model', for visulazing the model learned.
 133
 134 Usage:
 135
 136     rsem-plot-model modelF outF
 137
 138 modelF: the sample_name.model file generated by RSEM
 139 outF: the file name for plots generated from the model. It is a pdf file
 140
 141 The plots generated depends on read type and user configuration. It
 142 may include fragment length distribution, mate length distribution,
 143 read start position distribution (RSPD), quality score vs observed
 144 quality given a reference base, position vs percentage of sequencing
 145 error given a reference base.
 146
 147 fragment length distribution and mate length distribution: x-axis is fragment/mate length, y axis is the probability of generating a fragment/mate with the associated length
 148
 149 RSPD: Read Start Position Distribution. x-axis is bin number, y-axis is the probability of each bin. RSPD can be used as an indicator of 3' bias
 150
 151 Quality score vs. observed quality given a reference base: x-axis is Phred quality scores associated with data, y-axis is the "observed quality", Phred quality scores learned by RSEM from the data. Q = -10log_10(P), where Q is Phred quality score and P is the probability of sequencing error for a particular base
 152
 153 Position vs. percentage sequencing error given a reference base: x-axis is position and y-axis is percentage sequencing error
 154
 155 ## <a name="example"></a> Example
 156
 157 Suppose we download the mouse genome from UCSC Genome Browser.  We will
 158 use a reference_name of 'mm9'.  We have a FASTQ-formatted file,
 159 'mmliver.fq', containing single-end reads from one sample, which we call
 160 'mmliver_single_quals'.  We want to estimate expression values by using
 161 the single-end model with a fragment length distribution. We know that
 162 the fragment length distribution is approximated by a normal
 163 distribution with a mean of 150 and a standard deviation of 35. We wish
 164 to generate 95% credibility intervals in addition to maximum likelihood
 165 estimates.  RSEM will be allowed 1G of memory for the credibility
 166 interval calculation.  We will visualize the probabilistic read mappings
 167 generated by RSEM.
 168
 169 The commands for this scenario are as follows:
 170
 171     rsem-prepare-reference --gtf mm9.gtf --mapping knownIsoforms.txt --bowtie-path /sw/bowtie /data/mm9 /ref/mm9
 172     rsem-calculate-expression --bowtie-path /sw/bowtie --phred64-quals --fragment-length-mean 150.0 --fragment-length-sd 35.0 -p 8 --out-bam --calc-ci --memory-allocate 1024 /data/mmliver.fq /ref/mm9 mmliver_single_quals
 173     rsem-bam2wig mmliver_single_quals.sorted.bam mmliver_single_quals.sorted.wig mmliver_single_quals
 174
 175 ## <a name="simulation"></a> Simulation
 176
 177 ### Usage:
 178
 179     rsem-simulate-reads reference_name estimated_model_file estimated_isoform_results theta0 N output_name [-q]
 180
 181 estimated_model_file:  File containing model parameters.  Generated by
 182 rsem-calculate-expression.
 183 estimated_isoform_results: File containing isoform expression levels.
 184 Generated by rsem-calculate-expression.
 185 theta0: fraction of reads that are "noise" (not derived from a transcript).
 186 N: number of reads to simulate.
 187 output_name: prefix for all output files.
 188 [-q] : set it will stop outputting intermediate information.
 189
 190 ### Outputs:
 191
 192 output_name.fa if single-end without quality score;
 193 output_name.fq if single-end with quality score;
 194 output_name_1.fa & output_name_2.fa if paired-end without quality
 195 score;
 196 output_name_1.fq & output_name_2.fq if paired-end with quality score.
 197
 198 output_name.sim.isoforms.results, output_name.sim.genes.results : Results estimated based on sample values.
 199
 200 ## <a name="acknowledgements"></a> Acknowledgements
 201
 202 RSEM uses randomc.h and mersenne.cpp from
 203 <http://lxnt.info/rng/randomc.htm> for random number generation. RSEM
 204 also uses the [Boost C++](http://www.boost.org) and
 205 [samtools](http://samtools.sourceforge.net) libraries.
 206
 207 ## <a name="license"></a> License
 208
 209 RSEM is licensed under the [GNU General Public License v3](http://www.gnu.org/licenses/gpl-3.0.html).