Bio::Graphics::Glyph dna
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Summary
Bio::Graphics::Glyph::dna - The "dna" glyph
Package variables
Privates (from "my" definitions)
%complement = (g=>'c',a=>'t',t=>'a',c=>'g',n=>'n', G=>'C',A=>'T',T=>'A',C=>'G',N=>'N')
Inherit
Bio::Graphics::Glyph::generic
Synopsis
  See Bio::Graphics::Panel and Bio::Graphics::Glyph.
Description
This glyph draws DNA sequences. At high magnifications, this glyph
will draw the actual base pairs of the sequence (both strands). At
low magnifications, the glyph will plot the GC content. By default,
the GC calculation will use non-overlapping bins, but this can be
changed by specifying the gc_window option, in which case, a
sliding window calculation will be used.
For this glyph to work, the feature must return a DNA sequence string
in response to the dna() method. The following options are standard among all Glyphs. See
Bio::Graphics::Glyph for a full explanation.
  Option      Description                      Default
------ ----------- -------
-fgcolor Foreground color black -outlinecolor Synonym for -fgcolor -bgcolor Background color turquoise -fillcolor Synonym for -bgcolor -linewidth Line width 1 -height Height of glyph 10 -font Glyph font gdSmallFont -connector Connector type 0 (false) -connector_color Connector color black -label Whether to draw a label 0 (false) -description Whether to draw a description 0 (false) -hilite Highlight color undef (no color)
In addition to the common options, the following glyph-specific
options are recognized:
  Option      Description               Default
------ ----------- -------
-do_gc Whether to draw the GC true graph at low mags -gc_window Size of the sliding window <none>
to use in the GC content
calculation. If this is
not defined, non-
overlapping bins will be
used. If this is set to
"auto", then the glyph will
choose a window equal to
1% of the interval.
-gc_bins Fixed number of intervals 100 to sample across the panel. -axis_color Color of the vertical axes fgcolor in the GC content graph -strand Show both forward and auto reverse strand, one of "forward", "reverse", "both" or "auto". In "auto" mode, +1 strand features will show the plus strand -1 strand features will show the reverse complement and strandless features will show both
NOTE: -gc_window=>'auto' gives nice results and is recommended for
drawing GC content. The GC content axes draw slightly outside the
panel, so you may wish to add some extra padding on the right and
left.
Methods
description
No description
Code
height
No description
Code
do_gc
No description
Code
draw_component
No description
Code
draw_dna
No description
Code
draw_gc_content
No description
Code
make_key_feature
No description
Code
Methods description
None available.
Methods code
descriptiondescriptionprevnextTop
sub description {
 0
}
heightdescriptionprevnextTop
sub height {
  my $self = shift;
  my $font = $self->font;
  return $self->dna_fits ? 2*$font->height
       : $self->do_gc    ? $self->SUPER::height
       : 0;
}
do_gcdescriptionprevnextTop
sub do_gc {
  my $self = shift;
  my $do_gc = $self->option('do_gc');
  return  if defined($do_gc) && !$do_gc;
  return  1;
}
draw_componentdescriptionprevnextTop
sub draw_component {
  my $self = shift;
  my $gd = shift;
  my ($x1,$y1,$x2,$y2) = $self->bounds(@_);

  my $dna        = eval { $self->feature->seq };
  $dna           = $dna->seq if ref($dna) and $dna->can('seq'); # to catch Bio::PrimarySeqI objects
$dna or return; # workaround for my misreading of interface -- LS
$dna = $dna->seq if ref($dna) && $dna->can('seq'); if ($self->dna_fits) { $self->draw_dna($gd,$dna,$x1,$y1,$x2,$y2); } elsif ($self->do_gc) { $self->draw_gc_content($gd,$dna,$x1,$y1,$x2,$y2); }
}
draw_dnadescriptionprevnextTop
sub draw_dna {
  my $self = shift;

  my ($gd,$dna,$x1,$y1,$x2,$y2) = @_;
  my $pixels_per_base = $self->scale;
  my $feature = $self->feature;

  my $strand = $feature->strand || 1;
  $strand *= -1 if $self->{flip};

  my @bases = split '',$strand >= 0 ? $dna : $self->reversec($dna);

  my $color = $self->fgcolor;
  my $font  = $self->font;
  my $lineheight = $font->height;
  $y1 -= $lineheight/2 - 3;
my $strands = $self->option('strand') || 'auto'; my ($forward,$reverse); if ($strands eq 'auto') { $forward = $feature->strand >= 0; $reverse = $feature->strand <= 0; } elsif ($strands eq 'both') { $forward = $reverse = 1; } elsif ($strands eq 'reverse') { $reverse = 1; } else { $forward = 1; } # minus strand features align right, not left
$x1 += $pixels_per_base - $font->width - 1 if $strand < 0; for (my $i=0;$i<@bases;$i++) { my $x = $x1 + $i * $pixels_per_base; $gd->char($font,$x+2,$y1,$bases[$i],$color) if $forward; $gd->char($font,$x+2,$y1+($forward ? $lineheight:0), $complement{$bases[$i]}||$bases[$i],$color) if $reverse; }
}
draw_gc_contentdescriptionprevnextTop
sub draw_gc_content {
  my $self     = shift;
  my $gd       = shift;
  my $dna      = shift;
  my ($x1,$y1,$x2,$y2) = @_;

# get the options that tell us how to draw the GC content
my $bin_size = length($dna) / ($self->option('gc_bins') || 100);
$bin_size = 10 if $bin_size < 10; my $gc_window = $self->option('gc_window'); if ($gc_window && $gc_window eq 'auto' or $gc_window <= length($dna)) { $gc_window = length($dna)/100;
} # Calculate the GC content...
my @bins; my @datapoints; my $maxgc = -1000; my $mingc = +1000; if ($gc_window) { # ...using a sliding window...
for (my $i=$gc_window/2; $i <= length($dna) - $gc_window/2; $i++) { my $subseq = substr($dna, $i-$gc_window/2, $gc_window);
my $gc = $subseq =~ tr/gcGC/gcGC/; my $content = $gc / $gc_window;
push @datapoints, $content; $maxgc = $content if ($content > $maxgc); $mingc = $content if ($content < $mingc); } push @datapoints, 0.5 unless @datapoints; my $scale = $maxgc - $mingc; foreach (my $i; $i < @datapoints; $i++) { $datapoints[$i] = ($datapoints[$i] - $mingc) / $scale;
} $maxgc = int($maxgc * 100); $mingc = int($mingc * 100); } else { # ...or a fixed number of bins.
for (my $i = 0; $i < length($dna) - $bin_size; $i+= $bin_size) { my $subseq = substr($dna,$i,$bin_size); my $gc = $subseq =~ tr/gcGC/gcGC/; my $content = $gc/$bin_size;
$maxgc = $content if ($content > $maxgc); $mingc = $content if ($content < $mingc); push @bins,$content; } my $scale = $maxgc - $mingc; foreach (my $i; $i < @bins; $i++) { $bins[$i] = ($bins[$i] - $mingc) / $scale;
} $maxgc = int($maxgc * 100); $mingc = int($mingc * 100); } # Calculate values that will be used in the layout
push @bins,0.5 unless @bins; # avoid div by zero
my $bin_width = ($x2-$x1)/@bins;
my $bin_height = $y2-$y1; my $fgcolor = $self->fgcolor; my $bgcolor = $self->factory->translate_color($self->panel->gridcolor); my $axiscolor = $self->color('axis_color') || $fgcolor; # Draw the axes
my $fontwidth = $self->font->width; $gd->line($x1, $y1, $x1, $y2, $axiscolor); $gd->line($x2-2,$y1, $x2-2,$y2, $axiscolor); $gd->line($x1, $y1, $x1+3,$y1, $axiscolor); $gd->line($x1, $y2, $x1+3,$y2, $axiscolor); $gd->line($x1, ($y2+$y1)/2,$x1+3,($y2+$y1)/2,$axiscolor); $gd->line($x2-4,$y1, $x2-1, $y1, $axiscolor); $gd->line($x2-4,$y2, $x2-1, $y2, $axiscolor); $gd->line($x2-4,($y2+$y1)/2,$x2-1,($y2+$y1)/2,$axiscolor); $gd->line($x1+5,$y2, $x2-5,$y2, $bgcolor); $gd->line($x1+5,($y2+$y1)/2,$x2-5,($y2+$y1)/2,$bgcolor); $gd->line($x1+5,$y1, $x2-5,$y1, $bgcolor); $gd->string($self->font,$x1-length('% gc')*$fontwidth,$y1,'% gc',$axiscolor) if $bin_height > $self->font->height*2; # If we are using a sliding window, the GC graph will be scaled to use the full
# height of the glyph, so label the right vertical axis to show the scaling that# is in effect
$gd->string($self->font,$x2+3,$y1,"${maxgc}%",$axiscolor) if $bin_height > $self->font->height*2.5; $gd->string($self->font,$x2+3,$y2-$self->font->height,"${mingc}%",$axiscolor) if $bin_height > $self->font->height*2.5; # Draw the GC content graph itself
if ($gc_window) { my $graphwidth = $x2 - $x1; my $scale = $graphwidth / @datapoints;
my $gc_window_width = $gc_window/2 * $self->panel->scale;
for (my $i = 1; $i < @datapoints; $i++) { my $x = $i + $gc_window_width; my $xlo = $x1 + ($x - 1) * $scale; my $xhi = $x1 + $x * $scale; last if $xhi >= $self->panel->right-$gc_window_width; my $y = $y2 - ($bin_height*$datapoints[$i]); $gd->line($xlo, $y2 - ($bin_height*$datapoints[$i-1]), $xhi, $y, $fgcolor); } } else { for (my $i = 0; $i < @bins; $i++) { my $bin_start = $x1+$i*$bin_width; my $bin_stop = $bin_start + $bin_width; my $y = $y2 - ($bin_height*$bins[$i]); $gd->line($bin_start,$y, $bin_stop,$y, $fgcolor); $gd->line($bin_stop,$y, $bin_stop,$y2 - ($bin_height*$bins[$i+1]), $fgcolor) if $i < @bins-1; } }
}
make_key_featuredescriptionprevnextTop
sub make_key_feature {
  my $self = shift;
  my @gatc = qw(g a t c);
  my $offset = $self->panel->offset;
  my $scale = 1/$self->scale;  # base pairs/pixel

  my $start = $offset+1;
  my $stop  = $offset+100*$scale;
  my $feature =
    Bio::Graphics::Feature->new(-start=> $start,
				-stop => $stop,
				-seq  => join('',map{$gatc[rand 4]} (1..500)),
				-name => $self->option('key'),
				-strand => '+1',
			       );
  $feature;
}
General documentation
BUGSTop
Please report them.
SEE ALSOTop
Bio::Graphics::Panel,
Bio::Graphics::Glyph,
Bio::Graphics::Glyph::arrow,
Bio::Graphics::Glyph::cds,
Bio::Graphics::Glyph::crossbox,
Bio::Graphics::Glyph::diamond,
Bio::Graphics::Glyph::dna,
Bio::Graphics::Glyph::dot,
Bio::Graphics::Glyph::ellipse,
Bio::Graphics::Glyph::extending_arrow,
Bio::Graphics::Glyph::generic,
Bio::Graphics::Glyph::graded_segments,
Bio::Graphics::Glyph::heterogeneous_segments,
Bio::Graphics::Glyph::line,
Bio::Graphics::Glyph::pinsertion,
Bio::Graphics::Glyph::primers,
Bio::Graphics::Glyph::rndrect,
Bio::Graphics::Glyph::segments,
Bio::Graphics::Glyph::ruler_arrow,
Bio::Graphics::Glyph::toomany,
Bio::Graphics::Glyph::transcript,
Bio::Graphics::Glyph::transcript2,
Bio::Graphics::Glyph::translation,
Bio::Graphics::Glyph::triangle,
Bio::DB::GFF,
Bio::SeqI,
Bio::SeqFeatureI,
Bio::Das,
GD
AUTHORTop
Lincoln Stein <lstein@cshl.org>.
Sliding window GC calculation added by Peter Ashton <pda@sanger.ac.uk>.
Copyright (c) 2001 Cold Spring Harbor Laboratory
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself. See DISCLAIMER.txt for
disclaimers of warranty.