rsem-calculate-expression

   1 #!/usr/bin/perl
   2
   3 use Getopt::Long;
   4 use Pod::Usage;
   5 use File::Basename;
   6 use Switch;
   7 use strict;
   8
   9 #const
  10 my $BURNIN = 200;
  11 my $CHAINLEN = 1000;
  12 my $SAMPLEGAP = 1;
  13 my $CONFIDENCE = 0.95;
  14 my $NSPC = 50;
  15
  16 my $NMB = 1024; # default
  17
  18 my $status = 0;
  19
  20 my $read_type = 1; # default, single end with qual
  21
  22 my $bowtie_path = "";
  23 my $C = 2;
  24 my $E = 99999999;
  25 my $L = 25;
  26 my $maxHits = 200;
  27 my $phred33 = 0;
  28 my $phred64 = 0;
  29 my $solexa = 0;
  30
  31 my $is_sam = 0;
  32 my $is_bam = 0;
  33 my $fn_list = "";
  34 my $tagName = "XM";
  35
  36 my $probF = 0.5;
  37
  38 my $minL = 1;
  39 my $maxL = 1000;
  40 my $mean = -1;
  41 my $sd = 0;
  42
  43 my $estRSPD = 0;
  44 my $B = 20;
  45
  46 my $nThreads = 1;
  47 my $genBamF = 1;  # default is generating transcript bam file
  48 my $genGenomeBamF = 0;
  49 my $sampling = 0;
  50 my $calcCI = 0;
  51 my $quiet = 0;
  52 my $help = 0;
  53
  54 my $paired_end = 0;
  55 my $no_qual = 0;
  56 my $keep_intermediate_files = 0;
  57
  58 my $strand_specific = 0;
  59
  60 my $mTime = 0;
  61 my ($time_start, $time_end, $time_alignment, $time_rsem, $time_ci) = (0, 0, 0, 0, 0);
  62
  63 GetOptions("keep-intermediate-files" => \$keep_intermediate_files,
  64            "no-qualities" => \$no_qual,
  65            "paired-end" => \$paired_end,
  66            "strand-specific" => \$strand_specific,
  67            "sam" => \$is_sam,
  68            "bam" => \$is_bam,
  69            "sam-header-info=s" => \$fn_list,
  70            "tag=s" => \$tagName,
  71            "seed-length=i" => \$L,
  72            "bowtie-path=s" => \$bowtie_path,
  73            "bowtie-n=i" => \$C,
  74            "bowtie-e=i" => \$E,
  75            "bowtie-m=i" => \$maxHits,
  76            "phred33-quals" => \$phred33,
  77            "phred64-quals" => \$phred64, #solexa1.3-quals" => \$phred64,
  78            "solexa-quals" => \$solexa,
  79            "forward-prob=f" => \$probF,
  80            "fragment-length-min=i" => \$minL,
  81            "fragment-length-max=i" => \$maxL,
  82            "fragment-length-mean=f" => \$mean,
  83            "fragment-length-sd=f" => \$sd,
  84            "estimate-rspd" => \$estRSPD,
  85            "num-rspd-bins=i" => \$B,
  86            "p|num-threads=i" => \$nThreads,
  87            "output-genome-bam" => \$genGenomeBamF,
  88            "sampling-for-bam" => \$sampling,
  89            "calc-ci" => \$calcCI,
  90            "ci-memory=i" => \$NMB,
  91            "time" => \$mTime,
  92            "q|quiet" => \$quiet,
  93            "h|help" => \$help) or pod2usage(-exitval => 2, -verbose => 2);
  94
  95 pod2usage(-verbose => 2) if ($help == 1);
  96
  97
  98 #check parameters and options
  99
 100 if ($is_sam || $is_bam) {
 101     pod2usage(-msg => "Invalid number of arguments!", -exitval => 2, -verbose => 2) if (scalar(@ARGV) != 3);
 102     pod2usage(-msg => "--sam and --bam cannot be active at the same time!", -exitval => 2, -verbose => 2) if ($is_sam == 1&& $is_bam == 1);
 103     pod2usage(-msg => "--bowtie-path, --bowtie-n, --bowtie-e, --bowtie-m, --phred33-quals, --phred64-quals or --solexa-quals cannot be set if input is SAM/BAM format!", -exitval => 2, -verbose => 2) if ($bowtie_path ne "" || $C != 2 || $E != 99999999 || $maxHits != 200 || $phred33 || $phred64 || $solexa);
 104 }
 105 else {
 106     pod2usage(-msg => "Invalid number of arguments!", -exitval => 2, -verbose => 2) if (!$paired_end && scalar(@ARGV) != 3 || $paired_end && scalar(@ARGV) != 4);
 107     pod2usage(-msg => "Only one of --phred33-quals --phred64-quals/--solexa1.3-quals --solexa-suqls can be active!", -exitval => 2, -verbose => 2) if ($phred33 + $phred64 + $solexa > 1);
 108     podwusage(-msg => "--sam , --bam or --sam-header-info cannot be set if use bowtie aligner to produce alignments!", -exitval => 2, -verbose => 2) if ($is_sam || $is_bam || $fn_list ne "");
 109 }
 110
 111 pod2usage(-msg => "Forward probability should be in [0, 1]!", -exitval => 2, -verbose => 2) if ($probF < 0 || $probF > 1);
 112 pod2usage(-msg => "Min fragment length should be at least 1!", -exitval => 2, -verbose => 2) if ($minL < 1);
 113 pod2usage(-msg => "Min fragment length should be smaller or equal to max fragment length!", -exitval => 2, -verbose => 2) if ($minL > $maxL);
 114 pod2usage(-msg => "The memory allocated for calculating credibility intervals should be at least 1 MB!\n", -exitval => 2, -verbose => 2) if ($NMB < 1);
 115 pod2usage(-msg => "Number of threads should be at least 1!\n", -exitval => 2, -verbose => 2) if ($nThreads < 1);
 116 pod2usage(-msg => "Seed length should be at least 5!\n", -exitval => 2, -verbose => 2) if ($L < 5);
 117 pod2usage(-msg => "--sampling-for-bam cannot be specified if --out-bam is not specified!\n", -exitval => 2, -verbose => 2) if ($sampling && !$genBamF);
 118
 119 if ($L < 25) { print "Warning: the seed length set is less than 25! This is only allowed if the references are not added poly(A) tails.\n"; }
 120
 121 if ($strand_specific) { $probF = 1.0; }
 122
 123 my $mate1_list = "";
 124 my $mate2_list = "";
 125 my $inpF = "";
 126
 127 my ($refName, $sampleName, $sampleToken, $temp_dir, $stat_dir, $imdName) = ();
 128 my $gap = 32;
 129
 130 if ($paired_end) {
 131     if ($no_qual) { $read_type = 2; }
 132     else { $read_type = 3; }
 133 }
 134 else {
 135     if ($no_qual) { $read_type = 0; }
 136     else { $read_type = 1; }
 137 }
 138
 139 if (scalar(@ARGV) == 3) {
 140     if ($is_sam || $is_bam) { $inpF = $ARGV[0]; }
 141     else {$mate1_list = $ARGV[0]; }
 142     $refName = $ARGV[1];
 143     $sampleName = $ARGV[2];
 144 }
 145 else {
 146     $mate1_list = $ARGV[0];
 147     $mate2_list = $ARGV[1];
 148     $refName = $ARGV[2];
 149     $sampleName = $ARGV[3];
 150 }
 151
 152 if ($genGenomeBamF) {
 153     open(INPUT, "$refName.ti");
 154     my $line = <INPUT>; chomp($line);
 155     close(INPUT);
 156     my ($M, $type) = split(/ /, $line);
 157     pod2usage(-msg => "No genome information provided, so genome bam file cannot be generated!\n", -exitval => 2, -verbose => 2) if ($type != 0);
 158 }
 159
 160 my $pos = rindex($sampleName, '/');
 161 if ($pos < 0) { $sampleToken = $sampleName; }
 162 else { $sampleToken = substr($sampleName, $pos + 1); }
 163
 164 $temp_dir = "$sampleName.temp";
 165 $stat_dir = "$sampleName.stat";
 166
 167 if (!(-d $temp_dir) && !mkdir($temp_dir)) { print "Fail to create folder $temp_dir.\n"; exit(-1); }
 168 if (!(-d $stat_dir) && !mkdir($stat_dir)) { print "Fail to create folder $stat_dir.\n"; exit(-1); }
 169
 170 $imdName = "$temp_dir/$sampleToken";
 171
 172 if (!$is_sam && !$is_bam && $phred33 + $phred64 + $solexa == 0) { $phred33 = 1; }
 173
 174 my ($mate_minL, $mate_maxL) = (1, $maxL);
 175
 176 if ($bowtie_path ne "") { $bowtie_path .= "/"; }
 177
 178 my ($fn, $dir, $suf) = fileparse($0);
 179 my $command = "";
 180
 181 if (!$is_sam && !$is_bam) {
 182     $command = $bowtie_path."bowtie";
 183     if ($read_type == 0 || $read_type == 2) { $command .= " -f"; }
 184     else { $command .= " -q"; }
 185
 186     if ($phred33) { $command .= " --phred33-quals"; }
 187     elsif ($phred64) { $command .= " --phred64-quals"; }
 188     elsif ($solexa) { $command .= " --solexa-quals"; }
 189     else { print "Oh, no!!!"; exit(2); }
 190
 191     $command .= " -n $C -e $E -l $L";
 192
 193     if ($read_type == 2 || $read_type == 3) { $command .= " -I $minL -X $maxL"; }
 194
 195     if ($strand_specific || $probF == 1.0) { $command .= " --norc"; }
 196     elsif ($probF == 0.0) { $command .= " --nofw"; }
 197
 198     $command .= " -p $nThreads -a -m $maxHits -S";
 199     if ($quiet) { $command .= " --quiet"; }
 200
 201     $command .= " $refName";
 202     if ($read_type == 0 || $read_type == 1) {
 203         $command .= " $mate1_list";
 204     }
 205     else {
 206         $command .= " -1 $mate1_list -2 $mate2_list";
 207     }
 208
 209     $command .= " | gzip > $imdName.sam.gz";
 210
 211     if ($mTime) { $time_start = time(); }
 212
 213     &runCommand($command);
 214
 215     if ($mTime) { $time_end = time(); $time_alignment = $time_end - $time_start; }
 216
 217     $inpF = "$imdName.sam.gz";
 218     $is_sam = 1; # output of bowtie is a sam file
 219 }
 220
 221 if ($mTime) { $time_start = time(); }
 222
 223 $command = $dir."rsem-parse-alignments $refName $sampleName $sampleToken";
 224
 225 my $samInpType;
 226 if ($is_sam) { $samInpType = "s"; }
 227 elsif ($is_bam) { $samInpType = "b"; }
 228
 229 $command .= " $samInpType $inpF -t $read_type";
 230 if ($fn_list ne "") { $command .= " -l $fn_list"; }
 231 if ($tagName ne "") { $command .= " -tag $tagName"; }
 232 if ($quiet) { $command .= " -q"; }
 233
 234 &runCommand($command);
 235
 236 $command = $dir."rsem-build-read-index $gap";
 237 switch($read_type) {
 238     case 0  { $command .= " 0 $quiet $imdName\_alignable.fa"; }
 239     case 1  { $command .= " 1 $quiet $imdName\_alignable.fq"; }
 240     case 2  { $command .= " 0 $quiet $imdName\_alignable_1.fa $imdName\_alignable_2.fa"; }
 241     case 3  { $command .= " 1 $quiet $imdName\_alignable_1.fq $imdName\_alignable_2.fq"; }
 242 }
 243 &runCommand($command);
 244
 245 my $doesOpen = open(OUTPUT, ">$imdName.mparams");
 246 if ($doesOpen == 0) { print "Cannot generate $imdName.mparams!\n"; exit(-1); }
 247 print OUTPUT "$minL $maxL\n";
 248 print OUTPUT "$probF\n";
 249 print OUTPUT "$estRSPD\n";
 250 print OUTPUT "$B\n";
 251 print OUTPUT "$mate_minL $mate_maxL\n";
 252 print OUTPUT "$mean $sd\n";
 253 print OUTPUT "$L\n";
 254 close(OUTPUT);
 255
 256 $command = $dir."rsem-run-em $refName $read_type $sampleName $sampleToken -p $nThreads";
 257 if ($genBamF) {
 258     $command .= " -b $samInpType $inpF";
 259     if ($fn_list ne "") { $command .= " 1 $fn_list"; }
 260     else { $command .= " 0"; }
 261     if ($sampling) { $command .= " --sampling"; }
 262 }
 263 if ($calcCI) { $command .= " --gibbs-out"; }
 264 if ($quiet) { $command .= " -q"; }
 265
 266 &runCommand($command);
 267
 268 if ($genBamF) {
 269     $command = $dir."sam/samtools sort $sampleName.transcript.bam $sampleName.transcript.sorted";
 270     &runCommand($command);
 271     $command = $dir."sam/samtools index $sampleName.transcript.sorted.bam";
 272     &runCommand($command);
 273
 274     if ($genGenomeBamF) {
 275         $command = $dir."rsem-tbam2gbam $refName $sampleName.transcript.bam $sampleName.genome.bam";
 276         &runCommand($command);
 277         $command = $dir."sam/samtools sort $sampleName.genome.bam $sampleName.genome.sorted";
 278         &runCommand($command);
 279         $command = $dir."sam/samtools index $sampleName.genome.sorted.bam";
 280         &runCommand($command);
 281     }
 282 }
 283
 284 &collectResults("$imdName.iso_res", "$sampleName.isoforms.results"); # isoform level
 285 &collectResults("$imdName.gene_res", "$sampleName.genes.results"); # gene level
 286
 287 if ($mTime) { $time_end = time(); $time_rsem = $time_end - $time_start; }
 288
 289 if ($mTime) { $time_start = time(); }
 290
 291 if ($calcCI) {
 292     $command = $dir."rsem-run-gibbs $refName $sampleName $sampleToken $BURNIN $CHAINLEN $SAMPLEGAP";
 293 #    $command .= " -p $nThreads";
 294     if ($quiet) { $command .= " -q"; }
 295     &runCommand($command);
 296
 297     system("mv $sampleName.isoforms.results $imdName.isoforms.results.bak1");
 298     system("mv $sampleName.genes.results $imdName.genes.results.bak1");
 299     &collectResults("$imdName.iso_res", "$sampleName.isoforms.results"); # isoform level
 300     &collectResults("$imdName.gene_res", "$sampleName.genes.results"); # gene level
 301
 302     $command = $dir."rsem-calculate-credibility-intervals $refName $sampleName $sampleToken $CONFIDENCE $NSPC $NMB";
 303     if ($quiet) { $command .= " -q"; }
 304     &runCommand($command);
 305
 306     system("mv $sampleName.isoforms.results $imdName.isoforms.results.bak2");
 307     system("mv $sampleName.genes.results $imdName.genes.results.bak2");
 308     &collectResults("$imdName.iso_res", "$sampleName.isoforms.results"); # isoform level
 309     &collectResults("$imdName.gene_res", "$sampleName.genes.results"); # gene level
 310 }
 311
 312 if ($mTime) { $time_end = time(); $time_ci = $time_end - $time_start; }
 313
 314 if ($mTime) { $time_start = time(); }
 315
 316 if (!$keep_intermediate_files) {
 317     &runCommand("rm -rf $temp_dir", "Fail to delete the temporary folder!");
 318 }
 319
 320 if ($mTime) { $time_end = time(); }
 321
 322 if ($mTime) {
 323     open(OUTPUT, ">$sampleName.time");
 324     print OUTPUT "Alignment: $time_alignment s.\n";
 325     print OUTPUT "RSEM: $time_rsem s.\n";
 326     print OUTPUT "CI: $time_ci s.\n";
 327     my $time_del = $time_end - $time_start;
 328     print OUTPUT "Delete: $time_del s.\n";
 329     close(OUTPUT);
 330 }
 331
 332 # command, {err_msg}
 333 sub runCommand {
 334     print $_[0]."\n";
 335     my $status = system($_[0]);
 336     if ($status != 0) {
 337         my $errmsg;
 338         if (scalar(@_) > 1) { $errmsg = $_[1]; }
 339         else { $errmsg = "\"$command\" failed! Plase check if you provide correct parameters/options for the pipeline!"; }
 340         print $errmsg."\n";
 341         exit(-1);
 342     }
 343     print "\n";
 344 }
 345
 346 # inpF, outF
 347 sub collectResults {
 348     my $local_status;
 349     my ($inpF, $outF);
 350     my (@results, @ids) = ();
 351     my $line;
 352     my $cnt;
 353
 354     $inpF = $_[0];
 355     $outF = $_[1];
 356
 357     $local_status = open(INPUT, $inpF);
 358     if ($local_status == 0) { print "Fail to open file $inpF!\n"; exit(-1); }
 359
 360     $cnt = 0;
 361     @results = ();
 362
 363     while ($line = <INPUT>) {
 364         ++$cnt;
 365         chomp($line);
 366         my @local_arr = split(/\t/, $line);
 367         if ($cnt == 4) { @ids = @local_arr; }
 368         else { push(@results, \@local_arr); }
 369     }
 370
 371     push(@results, \@ids);
 372     close(INPUT);
 373
 374     $local_status = open(OUTPUT, ">$outF");
 375     if ($local_status == 0) { print "Fail to create file $outF!\n"; exit(-1); }
 376
 377     my $n = scalar(@results);
 378     my $m = scalar(@{$results[0]});
 379     for (my $i = 0; $i < $m; $i++) {
 380         my @out_arr = ();
 381         for (my $j = 0; $j < $n; $j++) { push(@out_arr, $results[$j][$i]); }
 382         $" = "\t";
 383         print OUTPUT "@out_arr\n";
 384     }
 385     close(OUTPUT);
 386 }
 387
 388
 389 __END__
 390
 391 =head1 NAME
 392
 393 rsem-calculate-expression
 394
 395 =head1 SYNOPSIS
 396
 397 =over
 398
 399  rsem-calculate-expression [options] upstream_read_file(s) reference_name sample_name
 400  rsem-calculate-expression [options] --paired-end upstream_read_file(s) downstream_read_file(s) reference_name sample_name
 401  rsem-calculate-expression [options] --sam/--bam [--paired-end] input reference_name sample_name
 402
 403 =back
 404
 405 =head1 ARGUMENTS
 406
 407 =over
 408
 409 =item B<upstream_read_files(s)>
 410
 411 Comma-separated list of files containing single-end reads or upstream reads for paired-end data.  By default, these files are assumed to be in FASTQ format.  If the --no-qualities option is specified, then FASTA format is expected.
 412
 413 =item B<downstream_read_file(s)>
 414
 415 Comma-separated list of files containing downstream reads which are paired with the upstream reads.  By default, these files are assumed to be in FASTQ format.  If the --no-qualities option is specified, then FASTA format is expected.
 416
 417 =item B<input>
 418
 419 SAM/BAM formatted input file.  If "-" is specified for the filename, SAM/BAM input is instead assumed to come from standard input. RSEM requires all alignments of the same read group together. For paired-end reads, RSEM also requires the two mates of any alignment be adjacent. See Description section for how to make input file obey RSEM's requirements.
 420
 421 =item B<reference_name>
 422
 423 The name of the reference used.  The user must have run 'rsem-prepare-reference' with this reference_name before running this program.
 424
 425 =item B<sample_name>
 426
 427 The name of the sample analyzed. All output files are prefixed by this name (e.g., sample_name.genes.results)
 428
 429 =back
 430
 431 =head1 OPTIONS
 432
 433 =over
 434
 435 =item B<--paired-end>
 436
 437 Input reads are paired-end reads. (Default: off)
 438
 439 =item B<--no-qualities>
 440
 441 Input reads do not contain quality scores. (Default: off)
 442
 443 =item B<--strand-specific>
 444
 445 The RNA-Seq protocol used to generate the reads is strand specific, i.e., all (upstream) reads are derived from the forward strand.  This option is equivalent to --forward-prob=1.0.  With this option set, if RSEM runs the Bowtie aligner, the '--norc' Bowtie option will be used, which disables alignment to the reverse strand of transcripts.  (Default: off)
 446
 447 =item B<--sam>
 448
 449 Input file is in SAM format. (Default: off)
 450
 451 =item B<--bam>
 452
 453 Input file is in BAM format. (Default: off)
 454
 455 =item B<--sam-header-info> <file>
 456
 457 RSEM reads header information from input by default. If this option is on, header information is read from the specified file. For the format of the file, please see SAM official website. (Default: "")
 458
 459 =item B<-p/--num-threads> <int>
 460
 461 Number of threads to use. Both Bowtie and expression estimation will use this many threads. (Default: 1)
 462
 463 =item B<--output-genome-bam>
 464
 465 Generate a BAM file, 'sample_name.genome.bam', with alignments mapped to genomic coordinates and annotated with their posterior probabilities. In addition, RSEM will call samtools (included in RSEM package) to sort and index the bam file. 'sample_name.genome.sorted.bam' and 'sample_name.genome.sorted.bam.bai' will be generated. (Default: off)
 466
 467 =item B<--sampling-for-bam>
 468
 469 When RSEM generates a BAM file, instead of outputing all alignments a read has with their posterior probabilities, one alignment is sampled and outputed according to the posterior probabilities. If the sampling result is that the read comes from the "noise" transcript, nothing is outputed. (Default: off)
 470
 471 =item B<--calc-ci>
 472
 473 Calculate 95% credibility intervals and posterior mean estimates.  (Default: off)
 474
 475 =item B<--seed-length> <int>
 476
 477 Seed length used by the read aligner.  Providing the correct value is important for RSEM. If RSEM runs Bowtie, it uses this value for Bowtie's seed length parameter. Any read with its or at least one of its mates' (for paired-end reads) length less than this value will be ignored. If the references are not added poly(A) tails, the minimum allowed value is 5, otherwise, the minimum allowed value is 25. Note that this script will only check if the value >= 5 and give a warning message if the value < 25 but >= 5. (Default: 25)
 478
 479 =item B<--tag> <string>
 480
 481 The name of the optional field used in the SAM input for identifying a read with too many valid alignments. The field should have the format <tagName>:i:<value>, where a <value> bigger than 0 indicates a read with too many alignments. (Default: "")
 482
 483 =item B<--bowtie-path> <path>
 484
 485 The path to the bowtie executables. (Default: the path to the bowtie executables is assumed to be in the user's PATH environment variable)
 486
 487 =item B<--bowtie-n> <int>
 488
 489 (Bowtie parameter) max # of mismatches in the seed. (Range: 0-3, Default: 2)
 490
 491 =item B<--bowtie-e> <int>
 492
 493 (Bowtie parameter) max sum of mismatch quality scores across the alignment. (Default: 99999999)
 494
 495 =item B<--bowtie-m> <int>
 496
 497 (Bowtie parameter) suppress all alignments for a read if > <int> valid alignments exist. (Default: 200)
 498
 499 =item B<--phred33-quals>
 500
 501 Input quality scores are encoded as Phred+33. (Default: on)
 502
 503 =item B<--phred64-quals>
 504
 505 Input quality scores are encoded as Phred+64 (default for GA Pipeline ver. >= 1.3). (Default: off)
 506
 507 =item B<--solexa-quals>
 508
 509 Input quality scores are solexa encoded (from GA Pipeline ver. < 1.3). (Default: off)
 510
 511 =item B<--forward-prob> <double>
 512
 513 Probability of generating a read from the forward strand of a transcript. Set to 1 for a strand-specific protocol where all (upstream) reads are derived from the forward strand, 0 for a strand-specific protocol where all (upstream) read are derived from the reverse strand, or 0.5 for a non-strand-specific protocol. (Default: 0.5)
 514
 515 =item B<--fragment-length-min> <int>
 516
 517 Minimum read/insert length allowed. This is also the value for the bowtie -I option. (Default: 1)
 518
 519 =item B<--fragment-length-max> <int>
 520
 521 Maximum read/insert length allowed. This is also the value for the bowtie -X option. (Default: 1000)
 522
 523 =item B<--fragment-length-mean> <double>
 524
 525 (single-end data only) The mean of the fragment length distribution, which is assumed to be a Gaussian. (Default: -1, which disables use of the fragment length distribution)
 526
 527 =item B<--fragment-length-sd> <double>
 528
 529 (single-end data only) The standard deviation of the fragment length distribution, which is assumed to be a Gaussian.  (Default: 0, which assumes that all fragments are of the same length, given by the rounded value of B<--fragment-length-mean>)
 530
 531 =item B<--estimate-rspd>
 532
 533 Set this option if you want to estimate the read start position distribution (RSPD) from data. Otherwise, RSEM will use a uniform RSPD. (Default: off)
 534
 535 =item B<--num-rspd-bins> <int>
 536
 537 Number of bins in the RSPD. Only relevant when '--estimate-rspd' is specified.  Use of the default setting is recommended. (Default: 20)
 538
 539 =item B<--ci-memory> <int>
 540
 541 Amount of memory (in MB) RSEM is allowed to use for computing credibility intervals. (Default: 1024)
 542
 543 =item B<--keep-intermediate-files>
 544
 545 Keep temporary files generated by RSEM.  RSEM creates a temporary directory, 'sample_name.temp', into which it puts all intermediate output files. If this directory already exists, RSEM overwrites all files generated by previous RSEM runs inside of it. By default, after RSEM finishes, the temporary directory is deleted.  Set this option to prevent the deletion of this directory and the intermediate files inside of it. (Default: off)
 546
 547 =item B<-q/--quiet>
 548
 549 Suppress the output of logging information. (Default: off)
 550
 551 =item B<-h/--help>
 552
 553 Show help information.
 554
 555 =back
 556
 557 =head1 DESCRIPTION
 558
 559 In its default mode, this program aligns input reads against a reference transcriptome with Bowtie and calculates expression values using the alignments.  RSEM assumes the data are single-end reads with quality scores, unless the '--paired-end' or '--no-qualities' options are specified.  Users may use an alternative aligner by specifying one of the --sam and --bam options, and providing an alignment file in the specified format. However, users should make sure that they align against the indices generated by 'rsem-prepare-reference' and the alignment file satisfies the requirements mentioned in ARGUMENTS section.
 560
 561 One simple way to make the alignment file (e.g. input.sam) satisfying RSEM's requirements (assuming the aligner used put mates in a paired-end read adjacent) is to use the following command:
 562
 563   sort -k 1,1 -s input.sam > input.sorted.sam
 564
 565 The SAM/BAM format RSEM uses is v1.4. However, it is compatible with old SAM/BAM format. However, RSEM cannot recognize 0x100 in the FLAG field. In addition, RSEM requires SEQ and QUAL not be '*'.
 566
 567 The user must run 'rsem-prepare-reference' with the appropriate reference before using this program.
 568
 569 For single-end data, it is strongly recommended that the user provide the fragment length distribution parameters (--fragment-length-mean and --fragment-length-sd).  For paired-end data, RSEM will automatically learn a fragment length distribution from the data.
 570
 571 Please note that some of the default values for the Bowtie parameters are not the same as those defined for Bowtie itself.
 572
 573 The temporary directory and all intermediate files will be removed when RSEM finishes unless '--keep-intermediate-files' is specified.
 574
 575 With the "--calc-ci" option, 95% credibility intervals and posterior mean estimates will be calculated in addition to maximum likelihood estimates.
 576
 577 =head1 OUTPUT
 578
 579 =over
 580
 581 =item B<sample_name.genes.results>
 582
 583 File containing gene level expression estimates. The format of each
 584 line in this file is:
 585
 586 gene_id expected_counts tau_value [pmc_value tau_pme_value tau_ci_lower_bound tau_ci_upper_bound] transcript_id_list
 587
 588 Fields are separated by the tab character. Fields within "[]" are only
 589 presented if '--calc-ci' is set. pme stands for posterior mean
 590 estimation. pmc stands for posterior mean counts. ci_lower_bound(l)
 591 means the lower bound of the credibility intervals, ci_upper_bound(u)
 592 means the upper bound of the credibility intervals. So the credibility
 593 interval is [l, u]. 'transcript_id_list' is a space-separated list of
 594 transcript_ids belonging to the gene. If no gene information is
 595 provided, this file has the same content as
 596 'sample_name.isoforms.results'.
 597
 598 =item B<sample_name.isoforms.results>
 599
 600 File containing isoform level expression values. The format of each
 601 line in this file is:
 602
 603 transcript_id expected_counts tau_value [pmc_value tau_pme_value tau_ci_lower_bound tau_ci_upper_bound] gene_id
 604
 605 Fields are separated by the tab character. 'gene_id' is the gene_id of
 606 the gene which this transcript belongs to. If no gene information is
 607 provided, 'gene_id' and 'transcript_id' are the same.
 608
 609 =item B<sample_name.transcript.bam, sample_name.transcript.sorted.bam and sample_name.transcript.sorted.bam.bai>
 610
 611 'sample_name.transcript.bam' is a BAM-formatted file of read
 612 alignments in transcript coordinates. The MAPQ field of each alignment
 613 is set to min(100, floor(-10 * log10(1.0 - w) + 0.5)), where w is the
 614 posterior probability of that alignment being the true mapping of a
 615 read.  In addition, RSEM pads a new tag ZW:f:value, where value is a
 616 single precision floating number representing the posterior
 617 probability.
 618
 619 'sample_name.transcript.sorted.bam' and
 620 'sample_name.transcript.sorted.bam.bai' are the sorted BAM file and
 621 indices generated by samtools (included in RSEM package).
 622
 623 =item B<sample_name.genome.bam, sample_name.genome.sorted.bam and sample_name.genome.sorted.bam.bai>
 624
 625 Only generated when --output-genome-bam is specified.
 626
 627 'sample_name.genome.bam' is a BAM-formatted file of read alignments in
 628 genomic coordinates. Alignments of reads that have identical genomic
 629 coordinates (i.e., alignments to different isoforms that share the
 630 same genomic region) are collapsed into one alignment.  The MAPQ field
 631 of each alignment is set to min(100, floor(-10 * log10(1.0 - w) +
 632 0.5)), where w is the posterior probability of that alignment being
 633 the true mapping of a read.  In addition, RSEM pads a new tag
 634 ZW:f:value, where value is a single precision floating number
 635 representing the posterior probability. If an alignment is spliced, a
 636 XS:A:value tag is also added, where value is either '+' or '-'
 637 indicating the strand of the transcript it aligns to.
 638
 639 'sample_name.genome.sorted.bam' and 'sample_name.genome.sorted.bam.bai' are the
 640 sorted BAM file and indices generated by samtools (included in RSEM package).
 641
 642 =item B<sample_name.stat>
 643
 644 This is a folder instead of a file. All model related statistics are stored in this folder. Use 'rsem-plot-model' can generate plots using this folder.
 645
 646 =back
 647
 648 =head1 EXAMPLES
 649
 650 Assume the path to the bowtie executables is in the user's PATH environment variable. Reference files are under '/ref' with name 'mm9'.
 651
 652 1) '/data/mmliver.fq', single-end reads with quality scores. Quality scores are encoded as for 'GA pipeline version >= 1.3'. We want to use 8 threads and generate a genome BAM file:
 653
 654  rsem-calculate-expression --phred64-quals \
 655                            -p 8 \
 656                            --output-genome-bam \
 657                            /data/mmliver.fq \
 658                            /ref/mm9 \
 659                            mmliver_single_quals
 660
 661 2) '/data/mmliver_1.fq' and '/data/mmliver_2.fq', paired-end reads with quality scores. Quality scores are in SANGER format. We want to use 8 threads and do not generate a genome BAM file:
 662
 663  rsem-calculate-expression -p 8 \
 664                            --paired-end \
 665                            /data/mmliver_1.fq \
 666                            /data/mmliver_2.fq \
 667                            /ref/mm9 \
 668                            mmliver_paired_end_quals
 669
 670 3) '/data/mmliver.fa', single-end reads without quality scores. We want to use 8 threads:
 671
 672  rsem-calculate-expression -p 8 \
 673                            --no-qualities \
 674                            /data/mmliver.fa \
 675                            /ref/mm9 \
 676                            mmliver_single_without_quals
 677
 678 4) Data are the same as 1). We want to take a fragment length distribution into consideration. We set the fragment length mean to 150 and the standard deviation to 35. In addition to a BAM file, we also want to generate credibility intervals.  We allow RSEM to use 1GB of memory for CI calculation:
 679
 680  rsem-calculate-expression --bowtie-path /sw/bowtie \
 681                            --phred64-quals \
 682                            --fragment-length-mean 150.0 \
 683                            --fragment-length-sd 35.0 \
 684                            -p 8 \
 685                            --output-genome-bam \
 686                            --calc-ci \
 687                            --ci-memory 1024 \
 688                            /data/mmliver.fq \
 689                            /ref/mm9 \
 690                            mmliver_single_quals
 691
 692 5) '/data/mmliver_paired_end_quals.bam', paired-end reads with quality scores.  We want to use 8 threads:
 693
 694  rsem-calculate-expression --paired-end \
 695                            --bam \
 696                            -p 8 \
 697                            /data/mmliver_paired_end_quals.bam \
 698                            /ref/mm9 \
 699                            mmliver_paired_end_quals
 700
 701 =cut