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