← Back to branch summary

~fuzzgun/emailgraph/trunk-1

« back to all changes in this revision

Viewing changes to README

  • Committer: Bob Mottram
  • Date: 2011-08-29 14:03:10 UTC
  • Revision ID: fuzzgun@gmail.com-20110829140310-xbpkgnag05gzm3c4
Ability to specify contacts to be merged

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
30
30
     --title <title>        Title to be added to a plot
31
31
     --min <number>         Minimum number of interactions
32
32
     --gender <M/F/MF>      Select only males (M), females (F) or male/female interactions (MF)
 
33
     --merge <filename>     Specify a merge file containing contacts to be merged
33
34
     --tests                Run unit tests
34
35
 -v  --version              Show version number
35
36
 -h  --help                 Show help
81
82
 
82
83
  Dot files may be viewed using other utilities, such as dotty, xdot or kgraphviewer.
83
84
 
 
85
MERGING CONTACTS
 
86
 
 
87
  In some cases you may see multiple nodes in the social graph which correspond to
 
88
  the same person.  This may be because their name is spelled differently, or because
 
89
  they have more then one email address.  To make the graph neater and easier to interpret
 
90
  it is possible to manually specify the names or email addresses of individuals which
 
91
  you wish to be merged together.  To do this create a merge file such as the following:
 
92
 
 
93
      J Smith,John Smith
 
94
      Clarke K,Clarke Kent
 
95
      Susan,Susan Jones
 
96
 
 
97
  In each case the first name is the name as it currently appears in the graph and the second
 
98
  is the name that you wish it to be changed to.  Then use the --merge option, for example:
 
99
 
 
100
      emailgraph -m mboxfile --dot --merge mymerges.txt > social_graph.dot
 
101
 
84
102
EXAMPLE USAGE GRAPHS
85
103
 
86
104
  In order for this to work you must have gnuplot installed.