lib/Text/Tradition/Stemma.pm

   1 package Text::Tradition::Stemma;
   2
   3 use Bio::Phylo::IO;
   4 use Encode qw( decode_utf8 );
   5 use File::Temp;
   6 use Graph;
   7 use Graph::Reader::Dot;
   8 use IPC::Run qw/ run binary /;
   9 use Text::Tradition::Error;
  10 use Text::Tradition::StemmaUtil qw/ character_input phylip_pars parse_newick /;
  11 use Moose;
  12
  13 has collation => (
  14     is => 'ro',
  15     isa => 'Text::Tradition::Collation',
  16     required => 1,
  17     weak_ref => 1,
  18     );
  19
  20 has graph => (
  21     is => 'rw',
  22     isa => 'Graph',
  23     predicate => 'has_graph',
  24     );
  25
  26 has distance_trees => (
  27     is => 'ro',
  28     isa => 'ArrayRef[Graph]',
  29     writer => '_save_distance_trees',
  30     predicate => 'has_distance_trees',
  31     );
  32
  33 has distance_program => (
  34         is => 'rw',
  35         isa => 'Str',
  36         default => '',
  37         );
  38
  39 sub BUILD {
  40     my( $self, $args ) = @_;
  41     # If we have been handed a dotfile, initialize it into a graph.
  42     if( exists $args->{'dot'} ) {
  43         $self->graph_from_dot( $args->{'dot'} );
  44     }
  45 }
  46
  47 sub graph_from_dot {
  48         my( $self, $dotfh ) = @_;
  49         my $reader = Graph::Reader::Dot->new();
  50         my $graph = $reader->read_graph( $dotfh );
  51         if( $graph ) {
  52                 $self->graph( $graph );
  53                 # Go through the nodes and set any non-hypothetical node to extant.
  54                 foreach my $v ( $self->graph->vertices ) {
  55                         $self->graph->set_vertex_attribute( $v, 'class', 'extant' )
  56                                 unless $self->graph->has_vertex_attribute( $v, 'class' );
  57                 }
  58         } else {
  59                 throw( "Failed to parse dot in $dotfh" );
  60         }
  61 }
  62
  63 sub as_dot {
  64     my( $self, $opts ) = @_;
  65
  66     # Get default and specified options
  67     my %graphopts = (
  68         # 'ratio' => 1,
  69     );
  70     my %nodeopts = (
  71                 'fontsize' => 11,
  72                 'style' => 'filled',
  73                 'fillcolor' => 'white',
  74                 'color' => 'white',
  75                 'shape' => 'ellipse',   # Shape for the extant nodes
  76         );
  77         my %edgeopts = (
  78                 'arrowhead' => 'none',
  79         );
  80         @graphopts{ keys %{$opts->{'graph'}} } = values %{$opts->{'graph'}}
  81                 if $opts->{'graph'};
  82         @nodeopts{ keys %{$opts->{'node'}} } = values %{$opts->{'node'}}
  83                 if $opts->{'node'};
  84         @edgeopts{ keys %{$opts->{'edge'}} } = values %{$opts->{'edge'}}
  85                 if $opts->{'edge'};
  86
  87         my @dotlines;
  88         push( @dotlines, 'digraph stemma {' );
  89         ## Print out the global attributes
  90         push( @dotlines, _make_dotline( 'graph', %graphopts ) ) if keys %graphopts;
  91         push( @dotlines, _make_dotline( 'edge', %edgeopts ) ) if keys %edgeopts;
  92         push( @dotlines, _make_dotline( 'node', %nodeopts ) ) if keys %nodeopts;
  93
  94         # Add each of the nodes.
  95     foreach my $n ( $self->graph->vertices ) {
  96         if( $self->graph->has_vertex_attribute( $n, 'label' ) ) {
  97                 my $ltext = $self->graph->get_vertex_attribute( $n, 'label' );
  98                 push( @dotlines, _make_dotline( $n, 'label' => $ltext ) );
  99         } else {
 100                 # Use the default display settings.
 101             push( @dotlines, "  $n;" );
 102         }
 103     }
 104     # Add each of our edges.
 105     foreach my $e ( $self->graph->edges ) {
 106         my( $from, $to ) = @$e;
 107         push( @dotlines, "  $from -> $to;" );
 108     }
 109     push( @dotlines, '}' );
 110
 111     return join( "\n", @dotlines );
 112 }
 113
 114
 115 # Another version of dot output meant for graph editing, thus
 116 # much simpler.
 117 sub editable {
 118         my $self = shift;
 119         my @dotlines;
 120         push( @dotlines, 'digraph stemma {' );
 121         my @real; # A cheap sort
 122     foreach my $n ( sort $self->graph->vertices ) {
 123         my $c = $self->graph->get_vertex_attribute( $n, 'class' );
 124         $c = 'extant' unless $c;
 125         if( $c eq 'extant' ) {
 126                 push( @real, $n );
 127         } else {
 128                         push( @dotlines, _make_dotline( $n, 'class' => $c ) );
 129                 }
 130     }
 131         # Now do the real ones
 132         foreach my $n ( @real ) {
 133                 push( @dotlines, _make_dotline( $n, 'class' => 'extant' ) );
 134         }
 135         foreach my $e ( sort _by_vertex $self->graph->edges ) {
 136                 my( $from, $to ) = @$e;
 137                 push( @dotlines, "  $from -> $to;" );
 138         }
 139     push( @dotlines, '}' );
 140     return join( "\n", @dotlines );
 141 }
 142
 143 sub _make_dotline {
 144         my( $obj, %attr ) = @_;
 145         my @pairs;
 146         foreach my $k ( keys %attr ) {
 147                 my $v = $attr{$k};
 148                 $v =~ s/\"/\\\"/g;
 149                 push( @pairs, "$k=\"$v\"" );
 150         }
 151         return sprintf( "  %s [ %s ];", $obj, join( ', ', @pairs ) );
 152 }
 153
 154 sub _by_vertex {
 155         return $a->[0].$a->[1] cmp $b->[0].$b->[1];
 156 }
 157
 158 # Render the stemma as SVG.
 159 sub as_svg {
 160     my( $self, $opts ) = @_;
 161     my $dot = $self->as_dot( $opts );
 162     my @cmd = qw/dot -Tsvg/;
 163     my( $svg, $err );
 164     my $dotfile = File::Temp->new();
 165     ## TODO REMOVE
 166     # $dotfile->unlink_on_destroy(0);
 167     binmode $dotfile, ':utf8';
 168     print $dotfile $dot;
 169     push( @cmd, $dotfile->filename );
 170     run( \@cmd, ">", binary(), \$svg );
 171     $svg = decode_utf8( $svg );
 172     return $svg;
 173 }
 174
 175 sub witnesses {
 176     my $self = shift;
 177     my @wits = grep { $self->graph->get_vertex_attribute( $_, 'class' ) eq 'extant' }
 178         $self->graph->vertices;
 179     return @wits;
 180 }
 181
 182 #### Methods for calculating phylogenetic trees ####
 183
 184 before 'distance_trees' => sub {
 185     my $self = shift;
 186     my %args = (
 187         'program' => 'phylip_pars',
 188         @_ );
 189     # TODO allow specification of method for calculating distance tree
 190     if( !$self->has_distance_trees
 191         || $args{'program'} ne $self->distance_program ) {
 192         # We need to make a tree before we can return it.
 193         my $dsub = 'run_' . $args{'program'};
 194         my( $ok, $result ) = $self->$dsub();
 195         if( $ok ) {
 196             # Save the resulting trees
 197             my $trees = parse_newick( $result );
 198             $self->_save_distance_trees( $trees );
 199             $self->distance_program( $args{'program'} );
 200         } else {
 201             throw( "Failed to calculate distance trees: $result" );
 202         }
 203     }
 204 };
 205
 206 sub run_phylip_pars {
 207         my $self = shift;
 208         my $cdata = character_input( $self->collation->make_alignment_table() );
 209         return phylip_pars( $cdata );
 210 }
 211
 212 sub throw {
 213         Text::Tradition::Error->throw(
 214                 'ident' => 'Stemma error',
 215                 'message' => $_[0],
 216                 );
 217 }
 218
 219
 220 no Moose;
 221 __PACKAGE__->meta->make_immutable;
 222
 223 1;