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 To take advantage of RSEM's built-in support for the Bowtie alignment
  44 program, you must have [Bowtie](http://bowtie-bio.sourceforge.net) installed.
  45
  46 ## <a name="usage"></a> Usage
  47
  48 ### I. Preparing Reference Sequences
  49
  50 RSEM can extract reference transcripts from a genome if you provide it
  51 with gene annotations in a GTF file.  Alternatively, you can provide
  52 RSEM with transcript sequences directly.
  53
  54 Please note that GTF files generated from the UCSC Table Browser do not
  55 contain isoform-gene relationship information.  However, if you use the
  56 UCSC Genes annotation track, this information can be recovered by
  57 downloading the knownIsoforms.txt file for the appropriate genome.
  58
  59 To prepare the reference sequences, you should run the
  60 'rsem-prepare-reference' program.  Run
  61
  62     rsem-prepare-reference --help
  63
  64 to get usage information or visit the [rsem-prepare-reference
  65 documentation page](http://deweylab.biostat.wisc.edu/rsem/rsem-prepare-reference.html).
  66
  67 ### II. Calculating Expression Values
  68
  69 To calculate expression values, you should run the
  70 'rsem-calculate-expression' program.  Run
  71
  72     rsem-calculate-expression --help
  73
  74 to get usage information or visit the [rsem-calculate-expression
  75 documentation page](http://deweylab.biostat.wisc.edu/rsem/rsem-calculate-expression.html).
  76
  77 #### Calculating expression values from single-end data
  78
  79 For single-end models, users have the option of providing a fragment
  80 length distribution via the --fragment-length-mean and
  81 --fragment-length-sd options.  The specification of an accurate fragment
  82 length distribution is important for the accuracy of expression level
  83 estimates from single-end data.  If the fragment length mean and sd are
  84 not provided, RSEM will not take a fragment length distribution into
  85 consideration.
  86
  87 #### Using an alternative aligner
  88
  89 By default, RSEM automates the alignment of reads to reference
  90 transcripts using the Bowtie alignment program.  To use an alternative
  91 alignment program, align the input reads against the file
  92 'reference_name.idx.fa' generated by rsem-prepare-reference, and format
  93 the alignment output in SAM or BAM format.  Then, instead of providing
  94 reads to rsem-calculate-expression, specify the --sam or --bam option
  95 and provide the SAM or BAM file as an argument.  When using an
  96 alternative aligner, you may also want to provide the --no-bowtie option
  97 to rsem-prepare-reference so that the Bowtie indices are not built.
  98
  99 ### III. Visualization
 100
 101 RSEM contains a version of samtools in the 'sam' subdirectory. When
 102 users specify the --out-bam option RSEM will produce three files:
 103 'sample_name.bam', the unsorted BAM file, 'sample_name.sorted.bam' and
 104 'sample_name.sorted.bam.bai' the sorted BAM file and indices generated
 105 by the samtools included.
 106
 107 #### a) Generating a UCSC Wiggle file
 108
 109 A wiggle plot representing the expected number of reads overlapping
 110 each position in the genome can be generated from the sorted BAM file
 111 output.  To generate the wiggle plot, run the 'rsem-bam2wig' program on
 112 the 'sample_name.sorted.bam' file.
 113
 114 Usage:
 115
 116     rsem-bam2wig bam_input wig_output wiggle_name
 117
 118 bam_input: sorted bam file
 119 wig_output: output file name, e.g. output.wig
 120 wiggle_name: the name the user wants to use for this wiggle plot
 121
 122 #### b) Loading a BAM and/or Wiggle file into the UCSC Genome Browser
 123
 124 Refer to the [UCSC custom track help page](http://genome.ucsc.edu/goldenPath/help/customTrack.html).
 125
 126 #### c) Visualize the model learned by RSEM
 127
 128 RSEM provides an R script, plotModel.R, for visulazing the model learned.
 129
 130 Usage:
 131
 132     plotModel.R modelF outF
 133
 134 modelF: the sample_name.model file generated by RSEM
 135 outF: the file name for plots generated from the model. It is a pdf file
 136
 137 The plots generated depends on read type and user configuration. It
 138 may include fragment length distribution, mate length distribution,
 139 read start position distribution (RSPD), quality score vs percentage
 140 of sequecing error given the reference base, position vs percentage of
 141 sequencing errro given the reference base.
 142
 143 ## <a name="example"></a> Example
 144
 145 Suppose we download the mouse genome from UCSC Genome Browser.  We will
 146 use a reference_name of 'mm9'.  We have a FASTQ-formatted file,
 147 'mmliver.fq', containing single-end reads from one sample, which we call
 148 'mmliver_single_quals'.  We want to estimate expression values by using
 149 the single-end model with a fragment length distribution. We know that
 150 the fragment length distribution is approximated by a normal
 151 distribution with a mean of 150 and a standard deviation of 35. We wish
 152 to generate 95% credibility intervals in addition to maximum likelihood
 153 estimates.  RSEM will be allowed 1G of memory for the credibility
 154 interval calculation.  We will visualize the probabilistic read mappings
 155 generated by RSEM.
 156
 157 The commands for this scenario are as follows:
 158
 159     rsem-prepare-reference --gtf mm9.gtf --mapping knownIsoforms.txt --bowtie-path /sw/bowtie /data/mm9 /ref/mm9
 160     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
 161     rsem-bam2wig mmliver_single_quals.sorted.bam mmliver_single_quals.sorted.wig mmliver_single_quals
 162
 163 ## <a name="simulation"></a> Simulation
 164
 165 ### Usage:
 166
 167     rsem-simulate-reads reference_name estimated_model_file estimated_isoform_results theta0 N output_name [-q]
 168
 169 estimated_model_file:  File containing model parameters.  Generated by
 170 rsem-calculate-expression.
 171 estimated_isoform_results: File containing isoform expression levels.
 172 Generated by rsem-calculate-expression.
 173 theta0: fraction of reads that are "noise" (not derived from a transcript).
 174 N: number of reads to simulate.
 175 output_name: prefix for all output files.
 176 [-q] : set it will stop outputting intermediate information.
 177
 178 ### Outputs:
 179
 180 output_name.fa if single-end without quality score;
 181 output_name.fq if single-end with quality score;
 182 output_name_1.fa & output_name_2.fa if paired-end without quality
 183 score;
 184 output_name_1.fq & output_name_2.fq if paired-end with quality score.
 185
 186 output_name.sim.isoforms.results, output_name.sim.genes.results : Results estimated based on sample values.
 187
 188 ## <a name="acknowledgements"></a> Acknowledgements
 189
 190 RSEM uses randomc.h and mersenne.cpp from
 191 <http://lxnt.info/rng/randomc.htm> for random number generation. RSEM
 192 also uses the [Boost C++](http://www.boost.org) and
 193 [samtools](http://samtools.sourceforge.net) libraries.
 194
 195 ## <a name="license"></a> License
 196
 197 RSEM is licensed under the [GNU General Public License v3](http://www.gnu.org/licenses/gpl-3.0.html).