Index of /perl/ascope/email/graph

 Name                    Last modified      Size  Description
 Parent Directory                             -   
 ASCOPE-Email-Graph-0..> 2008-11-22 09:16  3.0K  GZIP compressed docume>
 ASCOPE-Email-Graph-0..> 2008-11-22 09:16  5.3K  GZIP compressed docume>
 Changes                 2008-11-22 09:16  2.3K  
 docs.html               2008-11-22 09:16  6.2K  

NAME
    ASCOPE::Email::Graph - Aaron's widget for graphing email correspondence.

SYNOPSIS
      my $graph = ASCOPE::Email::Graph->new();

      $graph->add_mbox("/path/to/mbox");

      $graph->add_equivalencies(["me\@work.net", "me\@home.net", "me\@gmail.com"], "icanhas\@email.us");
      $graph->add_equivalencies(["buddy\@cheezburger.com", "bud.dy\@ohhai.com"]);
      $graph->add_equivalencies(["girly\@cheezburger.com", "grrrr.ly\@ohrly.com"]);

      $graph->add_cluster(["buddy\@cheezburger.com", "bud.dy\@ohhai.com",
                           "girly\@cheezburger.com", "grrrr.ly\@ohrly.com"],
                           "cheezburger");

      $graph->as_png("/path/to/graph.png");

DESCRIPTION
    Aaron's widget for graphing email correspondence.

PACKAGE METHODS
  __PACKAGE__->new(\%args)

    * colour
        String; a valid X11 color name or a RRGGBB hex string.

        Base colour used to fill individual nodes; each node will be filled
        using a percentage of this colour based on its weight.

        Default is *grey*

    * color
        No comment.

    * shape
        String; The shape to use for each each. From the GraphViz docs :

         This can be one of: 'record', 'plaintext', 'ellipse', 'circle',
         'egg', 'triangle', 'box', 'diamond', 'trapez-ium', 'parallelogram',
         'house', 'hexagon', 'octagon' 

        Defaut is box

    * fontsize
        Int.

        Font size used to write email addresses.

        Default is *6*

    * hash
        Boolean.

        Hash email addresses using *Digest::SHA1*. Addresses will be
        formatted as FOAF mmbox_sha1 strings, as in :

         sha1_hex("mailto:" . $address)

        Default is *false*.

    * obscure
        Do not print any labels for nodes.

        Default is *false*.

    Returns a *ASCOPE::Email::Graph* object. Woot!

OBJECT METHODS
  $obj->add_mbox($path)

  $obj->add_equivalencies(\@list, $key)

    Treat all the email addresses in *@list* as the same, assuming their
    value is *$key*.

    If *$key* is not defined then use the first address defined in *@list*.

  $obj->add_cluster(\@list, $key)

    Collect a set of email addresses in *@list* as the cluster, assuming the
    label is *$key*.

    If *$key* is not defined then use the first address defined in *@list*.

  $obj->as_canon($path);

  $obj->as_text($path);

  $obj->as_ps($path);

  $obj->as_hpgl($path);

  $obj->as_pcl($path);

  $obj->as_mif($path);

  $obj->as_pic($path);

  $obj->as_gd($path);

  $obj->as_gd2($path);

  $obj->as_jpeg($path);

  $obj->as_png($path);

  $obj->as_wbmp($path);

  $obj->as_cmap($path);

  $obj->as_ismap($path);

  $obj->as_imap($path);

  $obj->as_vrml($path);

  $obj->as_vtx($path);

  $obj->as_mp($path);

  $obj->as_fig($path);

  $obj->as_svg($path);

  $obj->as_plain($path);

VERSION
    0.2

DATE
    $Date: 2007/12/26 18:51:14 $

AUTHOR
    Aaron Straup Cope <ascope@cpan.org>

SEE ALSO
    http://www.aaronland.info/weblog/2004/06/07/5527/

    http://www.aaronland.info/weblog/2007/12/20/castles/#rocks

    http://www.tom-carden.co.uk/2007/11/08/sticks-and-rocks-illustrating-the
    -problem/

    GraphViz

    Email::Folder

LICENSE
    Copyright (c) 2004-2007 Aaron Straup Cope. All Rights Reserved.

    This is free software, you may use it and distribute it under the same
    terms as Perl itself.