rsem-plot-transcript-wiggles

   1 #!/usr/bin/env perl
   2
   3 use Getopt::Long;
   4 use Pod::Usage;
   5 use FindBin;
   6 use lib $FindBin::Bin;
   7 use strict;
   8
   9 use rsem_perl_utils;
  10
  11 my $gene_list = 0; # default is 0, means input is not a gene list
  12 my $transcript_list = 0; # default is 0, this option can only be turned on if allele-specific expression is calculated
  13 my $show_unique = 0; # 0, default value, means do not show unique transcript wiggles; 1 means show unique transcript wiggles
  14 my $help = 0;
  15
  16 GetOptions("gene-list" => \$gene_list,
  17            "transcript-list" => \$transcript_list,
  18            "show-unique" => \$show_unique,
  19            "h|help" => \$help) or pod2usage(-exitval => 2, -verbose => 2);
  20
  21 pod2usage(-verbose => 2) if ($help == 1);
  22 pod2usage(-msg => "Invalid number of arguments!", -exitval => 2, -verbose => 2) if (scalar(@ARGV) != 3);
  23
  24 my $alleleS = 0;
  25 if (-e "$ARGV[0].alleles.results") { $alleleS = 1; }
  26
  27 pod2usage(-msg => "--transcript-list cannot be set if allele-specific reference is not built!", -exitval => 2, -verbose => 2) if (!$alleleS && $transcript_list);
  28 pod2usage(-msg => "--gene-list and --transcript-list cannot be set at the same time!", -exitval => 2, -verbose => 2) if ($gene_list && $transcript_list);
  29
  30 my $dir = "$FindBin::Bin/";
  31 my $command = "";
  32
  33 unless (-e "$ARGV[0].transcript.sorted.bam") {
  34     $command = $dir."sam/samtools sort $ARGV[0].transcript.bam $ARGV[0].transcript.sorted";
  35     &runCommand($command);
  36 }
  37 unless (-e "$ARGV[0].transcript.readdepth") {
  38     $command = $dir."rsem-bam2readdepth $ARGV[0].transcript.sorted.bam $ARGV[0].transcript.readdepth";
  39     &runCommand($command);
  40 }
  41
  42 if ($show_unique) {
  43     unless (-e "$ARGV[0].uniq.transcript.bam") {
  44         $command = $dir."rsem-get-unique $ARGV[0].transcript.bam $ARGV[0].uniq.transcript.bam";
  45         &runCommand($command);
  46     }
  47     unless (-e "$ARGV[0].uniq.transcript.sorted.bam") {
  48         $command = $dir."sam/samtools sort $ARGV[0].uniq.transcript.bam $ARGV[0].uniq.transcript.sorted";
  49         &runCommand($command);
  50     }
  51     unless (-e "$ARGV[0].uniq.transcript.readdepth") {
  52         $command = $dir."rsem-bam2readdepth $ARGV[0].uniq.transcript.sorted.bam $ARGV[0].uniq.transcript.readdepth";
  53         &runCommand($command);
  54     }
  55 }
  56
  57 my $id_type;
  58
  59 if ($alleleS) {
  60     $id_type = 0;
  61     if ($transcript_list) { $id_type = 1; }
  62     if ($gene_list) { $id_type = 2; }
  63 }
  64 else {
  65     $id_type = 1;
  66     if ($gene_list) { $id_type = 2; }
  67 }
  68
  69 $command = $dir."rsem-gen-transcript-plots $ARGV[0] $ARGV[1] $alleleS $id_type $show_unique $ARGV[2]";
  70 &runCommand($command);
  71
  72 __END__
  73
  74 =head1 NAME
  75
  76 rsem-plot-transcript-wiggles
  77
  78 =head1 SYNOPSIS
  79
  80 rsem-plot-transcript-wiggles [options] sample_name input_list output_plot_file
  81
  82 =head1 ARGUMENTS
  83
  84 =over
  85
  86 =item B<sample_name>
  87
  88 The name of the sample analyzed.
  89
  90 =item B<input_list>
  91
  92 A list of transcript ids or gene ids. But it cannot be a mixture of transcript & gene ids. Each id occupies one line without extra spaces.
  93
  94 =item B<output_plot_file>
  95
  96 The file name of the pdf file which contains all plots.
  97
  98 =back
  99
 100 =head1 OPTIONS
 101
 102 =over
 103
 104 =item B<--gene-list>
 105
 106 The input-list is a list of gene ids. (Default: off)
 107
 108 =item B<--transcript-list>
 109
 110 The input-list is a list of transcript ids. This option can only be turned on if allele-specific expression is calculated. (Default: off)
 111
 112 =item B<--show-unique>
 113
 114 Show the wiggle plots as stacked bar plots. See description section for details. (Default: off)
 115
 116 =item B<-h/--help>
 117
 118 Show help information.
 119
 120 =back
 121
 122 =head1 DESCRIPTION
 123
 124 This program generates transcript wiggle plots and outputs them in a pdf file. This program can accept either a list of transcript ids or gene ids (if transcript to gene mapping information is provided) and has two modes of showing wiggle plots. If '--show-unique' is not specified, the wiggle plot for each transcript is a histogram where each position has the expected read depth at this position as its height. If '--show-unique' is specified, for each transcript a stacked bar plot is generated. For each position, the read depth of unique reads, which have only one alignment, is showed in black. The read depth of multi-reads, which align to more than one places, is showed in red on top of the read depth of unique reads.This program will use some files RSEM generated previouslly. So please do not delete/move any file 'rsem-calculate-expression' generated. If allele-specific expression is calculated, the basic unit for plotting is an allele-specific transcript and plots can be grouped by either transcript ids (--transcript-list) or gene ids (--gene-list).
 125
 126 =head1 OUTPUT
 127
 128 =over
 129
 130 =item B<output_plot_file>
 131
 132 This is a pdf file containing all plots generated. If a list of transcript ids is provided, each page display at most 6 plots in 3 rows and 2 columns. If gene ids are provided, each page display a gene. The gene's id is showed at the top and all its transcripts' wiggle plots are showed in this page. The arrangment of plots is determined automatically. For each transcript wiggle plot, the transcript id is displayed as title. x-axis is position in the transcript and y-axis is read depth. If allele-specific expression is calculated, the basin unit becomes an allele-specific transcript and transcript ids and gene ids can be used to group allele-specific transcripts.
 133
 134 =item B<sample_name.transcript.sorted.bam and sample_name.transcript.readdepth>
 135
 136 If these files do not exist, 'rsem-plot-transcript-wiggles' will automatically generate them.
 137
 138 =item B<sample_name.uniq.transcript.bam, sample_name.uniq.transcript.sorted.bam and sample_name.uniq.transcript.readdepth>
 139
 140 If '--show-unique' option is specified and these files do not exist, 'rsem-plot-transcript-wiggles' will automatically generate them.
 141
 142 =back
 143
 144 =head1 EXAMPLES
 145
 146 Suppose sample_name and output_plot_file are set to 'mmliver_single_quals' and 'output.pdf' respectively. input_list is set to 'transcript_ids.txt' if transcript ids are provided, and is set to 'gene_ids.txt' if gene ids are provided.
 147
 148 1) Transcript ids are provided and we just want normal wiggle plots:
 149
 150  rsem-plot-transcript-wiggles mmliver_single_quals transcript_ids.txt output.pdf
 151
 152 2) Gene ids are provided and we want to show stacked bar plots:
 153
 154  rsem-plot-transcript-wiggles --gene-list --show-unique mmliver_single_quals gene_ids.txt output.pdf
 155
 156 =cut