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 * [Generate Transcript-to-Gene-Map from Trinity Output](#gen_trinity)
  17 * [Acknowledgements](#acknowledgements)
  18 * [License](#license)
  19
  20 * * *
  21
  22 ## <a name="introduction"></a> Introduction
  23
  24 RSEM is a software package for estimating gene and isoform expression
  25 levels from RNA-Seq data.  The new RSEM package (rsem-1.x) provides an
  26 user-friendly interface, supports threads for parallel computation of
  27 the EM algorithm, single-end and paired-end read data, quality scores,
  28 variable-length reads and RSPD estimation. It can also generate
  29 genomic-coordinate BAM files and UCSC wiggle files for
  30 visualization. In addition, it provides posterior mean and 95%
  31 credibility interval estimates for expression levels. For
  32 visualization, it can also generate transcript-coordinate BAM files
  33 and visualize them and also models learned.
  34
  35 ## <a name="compilation"></a> Compilation & Installation
  36
  37 To compile RSEM, simply run
  38
  39     make
  40
  41 To install, simply put the rsem directory in your environment's PATH
  42 variable.
  43
  44 ### Prerequisites
  45
  46 C++ and Perl are required to be installed.
  47
  48 To take advantage of RSEM's built-in support for the Bowtie alignment
  49 program, you must have [Bowtie](http://bowtie-bio.sourceforge.net) installed.
  50
  51 If you want to plot model learned by RSEM, you should also install R.
  52
  53 ## <a name="usage"></a> Usage
  54
  55 ### I. Preparing Reference Sequences
  56
  57 RSEM can extract reference transcripts from a genome if you provide it
  58 with gene annotations in a GTF file.  Alternatively, you can provide
  59 RSEM with transcript sequences directly.
  60
  61 Please note that GTF files generated from the UCSC Table Browser do not
  62 contain isoform-gene relationship information.  However, if you use the
  63 UCSC Genes annotation track, this information can be recovered by
  64 downloading the knownIsoforms.txt file for the appropriate genome.
  65
  66 To prepare the reference sequences, you should run the
  67 'rsem-prepare-reference' program.  Run
  68
  69     rsem-prepare-reference --help
  70
  71 to get usage information or visit the [rsem-prepare-reference
  72 documentation page](http://deweylab.biostat.wisc.edu/rsem/rsem-prepare-reference.html).
  73
  74 ### II. Calculating Expression Values
  75
  76 To calculate expression values, you should run the
  77 'rsem-calculate-expression' program.  Run
  78
  79     rsem-calculate-expression --help
  80
  81 to get usage information or visit the [rsem-calculate-expression
  82 documentation page](http://deweylab.biostat.wisc.edu/rsem/rsem-calculate-expression.html).
  83
  84 #### Calculating expression values from single-end data
  85
  86 For single-end models, users have the option of providing a fragment
  87 length distribution via the --fragment-length-mean and
  88 --fragment-length-sd options.  The specification of an accurate fragment
  89 length distribution is important for the accuracy of expression level
  90 estimates from single-end data.  If the fragment length mean and sd are
  91 not provided, RSEM will not take a fragment length distribution into
  92 consideration.
  93
  94 #### Using an alternative aligner
  95
  96 By default, RSEM automates the alignment of reads to reference
  97 transcripts using the Bowtie alignment program.  To use an alternative
  98 alignment program, align the input reads against the file
  99 'reference_name.idx.fa' generated by rsem-prepare-reference, and format
 100 the alignment output in SAM or BAM format.  Then, instead of providing
 101 reads to rsem-calculate-expression, specify the --sam or --bam option
 102 and provide the SAM or BAM file as an argument.  When using an
 103 alternative aligner, you may also want to provide the --no-bowtie option
 104 to rsem-prepare-reference so that the Bowtie indices are not built.
 105
 106 However, please note that RSEM does ** not ** support gapped
 107 alignments. So make sure that your aligner does not produce alignments
 108 with intersions/deletions. Also, please make sure that you use
 109 'reference_name.idx.fa' , which is generated by RSEM, to build your
 110 aligner's indices.
 111
 112 ### III. Visualization
 113
 114 RSEM contains a version of samtools in the 'sam' subdirectory. RSEM
 115 will always produce three files:'sample_name.transcript.bam', the
 116 unsorted BAM file, 'sample_name.transcript.sorted.bam' and
 117 'sample_name.transcript.sorted.bam.bai' the sorted BAM file and
 118 indices generated by the samtools included. All three files are in
 119 transcript coordinates. When users specify the --output-genome-bam
 120 option RSEM will produce three files: 'sample_name.genome.bam', the
 121 unsorted BAM file, 'sample_name.genome.sorted.bam' and
 122 'sample_name.genome.sorted.bam.bai' the sorted BAM file and indices
 123 generated by the samtools included. All these files are in genomic
 124 coordinates.
 125
 126 #### a) Generating a UCSC Wiggle file
 127
 128 A wiggle plot representing the expected number of reads overlapping
 129 each position in the genome can be generated from the sorted genome
 130 BAM file output.  To generate the wiggle plot, run the 'rsem-bam2wig'
 131 program on the 'sample_name.genome.sorted.bam' file.
 132
 133 Usage:
 134
 135     rsem-bam2wig bam_input wig_output wiggle_name
 136
 137 bam_input: sorted bam file
 138 wig_output: output file name, e.g. output.wig
 139 wiggle_name: the name the user wants to use for this wiggle plot
 140
 141 #### b) Loading a BAM and/or Wiggle file into the UCSC Genome Browser
 142
 143 Refer to the [UCSC custom track help page](http://genome.ucsc.edu/goldenPath/help/customTrack.html).
 144
 145 #### c) Generating Transcript Wiggle Plots
 146
 147 To generate transcript wiggle plots, you should run the
 148 'rsem-plot-transcript-wiggles' program.  Run
 149
 150     rsem-plot-transcript-wiggles --help
 151
 152 to get usage information or visit the [rsem-plot-transcript-wiggles
 153 documentation page](http://deweylab.biostat.wisc.edu/rsem/rsem-plot-transcript-wiggles.html).
 154
 155 #### d) Visualize the model learned by RSEM
 156
 157 RSEM provides an R script, 'rsem-plot-model', for visulazing the model learned.
 158
 159 Usage:
 160
 161     rsem-plot-model sample_name output_plot_file
 162
 163 sample_name: the name of the sample analyzed
 164 output_plot_file: the file name for plots generated from the model. It is a pdf file
 165
 166 The plots generated depends on read type and user configuration. It
 167 may include fragment length distribution, mate length distribution,
 168 read start position distribution (RSPD), quality score vs observed
 169 quality given a reference base, position vs percentage of sequencing
 170 error given a reference base and histogram of reads with different
 171 number of alignments.
 172
 173 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
 174
 175 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
 176
 177 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
 178
 179 Position vs. percentage sequencing error given a reference base: x-axis is position and y-axis is percentage sequencing error
 180
 181 Histogram of reads with different number of alignments: x-axis is the number of alignments a read has and y-axis is the number of such reads. The inf in x-axis means number of reads filtered due to too many alignments
 182
 183 ## <a name="example"></a> Example
 184
 185 Suppose we download the mouse genome from UCSC Genome Browser.  We
 186 will use a reference_name of 'mm9'.  We have a FASTQ-formatted file,
 187 'mmliver.fq', containing single-end reads from one sample, which we
 188 call 'mmliver_single_quals'.  We want to estimate expression values by
 189 using the single-end model with a fragment length distribution. We
 190 know that the fragment length distribution is approximated by a normal
 191 distribution with a mean of 150 and a standard deviation of 35. We
 192 wish to generate 95% credibility intervals in addition to maximum
 193 likelihood estimates.  RSEM will be allowed 1G of memory for the
 194 credibility interval calculation.  We will visualize the probabilistic
 195 read mappings generated by RSEM on UCSC genome browser. We will
 196 generate a list of genes' transcript wiggle plots in 'output.pdf'. The
 197 list is 'gene_ids.txt'. We will visualize the models learned in
 198 'mmliver_single_quals.models.pdf'
 199
 200 The commands for this scenario are as follows:
 201
 202     rsem-prepare-reference --gtf mm9.gtf --mapping knownIsoforms.txt --bowtie-path /sw/bowtie /data/mm9 /ref/mm9
 203     rsem-calculate-expression --bowtie-path /sw/bowtie --phred64-quals --fragment-length-mean 150.0 --fragment-length-sd 35.0 -p 8 --output-genome-bam --calc-ci --memory-allocate 1024 /data/mmliver.fq /ref/mm9 mmliver_single_quals
 204     rsem-bam2wig mmliver_single_quals.sorted.bam mmliver_single_quals.sorted.wig mmliver_single_quals
 205     rsem-plot-transcript-wiggles --gene-list --show-unique mmliver_single_quals gene_ids.txt output.pdf
 206     rsem-plot-model mmliver_single_quals mmliver_single_quals.models.pdf
 207
 208 ## <a name="simulation"></a> Simulation
 209
 210 ### Usage:
 211
 212     rsem-simulate-reads reference_name estimated_model_file estimated_isoform_results theta0 N output_name [-q]
 213
 214 estimated_model_file:  file containing model parameters.  Generated by
 215 rsem-calculate-expression.
 216 estimated_isoform_results: file containing isoform expression levels.
 217 Generated by rsem-calculate-expression.
 218 theta0: fraction of reads that are "noise" (not derived from a transcript).
 219 N: number of reads to simulate.
 220 output_name: prefix for all output files.
 221 [-q] : set it will stop outputting intermediate information.
 222
 223 ### Outputs:
 224
 225 output_name.fa if single-end without quality score;
 226 output_name.fq if single-end with quality score;
 227 output_name_1.fa & output_name_2.fa if paired-end without quality
 228 score;
 229 output_name_1.fq & output_name_2.fq if paired-end with quality score.
 230
 231 output_name.sim.isoforms.results, output_name.sim.genes.results : Results estimated based on sample values.
 232
 233 ## <a name="gen_trinity"></a> Generate Transcript-to-Gene-Map from Trinity Output
 234
 235 For Trinity users, RSEM provides a perl script to generate transcript-to-gene-map file from the fasta file produced by Trinity.
 236
 237 ### Usage:
 238
 239     extract-transcript-to-gene-map-from-trinity trinity_fasta_file map_file
 240
 241 trinity_fasta_file: the fasta file produced by trinity, which contains all transcripts assembled.
 242 map_file: transcript-to-gene-map file's name.
 243
 244 ## <a name="acknowledgements"></a> Acknowledgements
 245
 246 RSEM uses the [Boost C++](http://www.boost.org) and
 247 [samtools](http://samtools.sourceforge.net) libraries.
 248
 249 ## <a name="license"></a> License
 250
 251 RSEM is licensed under the [GNU General Public License v3](http://www.gnu.org/licenses/gpl-3.0.html).