Phylo/Parsers/Adjacency.pm

filter: Statementstmt 98.3% 61 / 62 Branchbran 75.0% 15 / 20 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 6 / 6 Podpod n/a totaltotal 93.1% 82 / 88 CC 13 SCAR 22.8
CC
13
Cov
93%
_parse
13.1
BEGIN
1.0
BEGIN
1.0
CRAP 9.8
« Phylo/Forest/DrawTreeRole.pm ↑ Summary Phylo/Unparsers/Cdao.pm »
1 package Bio::Phylo::Parsers::Adjacency;
2 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
3 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 ▶use base 'Bio::Phylo::Parsers::Abstract';
Subroutine BEGIN: called CC=1 SCAR=0.0
5 1 ▶use Bio::Phylo::Util::Exceptions 'throw';
Subroutine BEGIN: called CC=1 SCAR=0.0
6 1 ▶use Bio::Phylo::Util::CONSTANT qw'/looks_like/ :namespaces :objecttypes';
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 =head1 NAME
9  
10 Bio::Phylo::Parsers::Adjacency - Parser used by Bio::Phylo::IO, no serviceable parts inside
11  
12 =head1 DESCRIPTION
13  
14 This module parses a tree structure from tabular data organized as an "adjacency
15 list", i.e. child -> parent relationships. The table should at least have the
16 following columns: 'child' and 'parent'. 'length' is interpreted as branch
17 length. Columns starting with 'node:' are assigned as semantic annotations
18 to the focal node, columns starting with 'branch:' are assigned to the focal
19 branch. Records need to be listed in pre-order, so that references to parent
20 nodes can be resolved immediately. Consequently, the root is the first record,
21 without a parent. Example:
22  
23 ((A:1,B:2)n1:3,C:4)n2:0;
24  
25 Becomes (with an extra example annotation):
26  
27 child parent length node:dcterms:identifier
28 n2 0 35462
29 n1 n2 3 34987
30 A n1 1 73843
31 B n1 2 98743
32 C n2 4 39847
33  
34 =cut
35  
36 1 ▶sub _parse {
Subroutine _parse: called CC=13 SCAR=25.7
37 1 my $self = shift;
38 1 my $fh = $self->_handle;
39 1 my $fac = $self->_factory;
40 1 my $log = $self->_logger;
41 1 my $tree = $fac->create_tree;
42 1 my $ns = $self->_args->{'-namespaces'};
43 1 ▶ if ( $ns ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($ns) 1 0 1
44 1 $tree->set_namespaces( %{ $ns } );
45 }
46 1 my ( @header, %node_cols );
47 1 my %node_for_id;
48 1 ▶ LINE: while (<$fh>) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined($_ = readline $fh)) 6 1 7
49 6 ▶ unless ( scalar(keys(%node_for_id)) % 1000 ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (scalar(keys %node_for_id) % 1000) 2 4 6
50 2 $log->debug("processed node " . scalar(keys(%node_for_id)));
51 }
52 6 chomp;
53
54 # the first line is the header row
55 6 ▶ if ( not @header ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (@header) 1 5 6
56 1 @header = split /\t/, $_;
57 1 for my $col ( @header ) {
58 4 ▶ if ( $col =~ /^node:(.+)$/ ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($col =~ /^node:(.+)$/) 1 3 4
59 1 my $predicate = $1;
60 1 $node_cols{$col} = $predicate;
61 }
62 }
63 1 next LINE;
64 }
65
66 # this is a record
67 5 my @fields = split /\t/, $_;
68 5 my %record = map { $header[$_] => $fields[$_] } 0 .. $#header;
69
70 # create node
71 5 my $name = $record{'child'};
72 5 my $pname = $record{'parent'};
73 5 my $node = $fac->create_node( '-name' => $name );
74 5 $tree->insert($node);
75 5 $node_for_id{$name} = $node;
76
77 # build the tree structure
78 5 ▶ if ( my $parent = $node_for_id{$pname} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $parent = $node_for_id{$pname}) 4 1 5
79 4 $node->set_parent($parent);
80 }
81
82 # assign branch length, if defined
83 5 ▶ if ( defined $record{'length'} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $record{"length"}) 5 0 5
84 5 $node->set_branch_length($record{'length'});
85 }
86
87 # now see if there are any node columns
88 5 for my $col ( keys %node_cols ) {
89 5 my $value = $record{$col};
90 5 ▶ if ( $value ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($value) 5 0 5
91 5 my $predicate = $node_cols{$col};
92 5 ▶ if ( $predicate =~ /^(.+)?:.+$/ ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($predicate =~ /^(.+)?:.+$/) 5 0 5
93 5 my $prefix = $1;
94 5 ▶ if ( my $ns = $Bio::Phylo::Util::CONSTANT::NS->{$prefix} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $ns = $Bio::Phylo::Util::CONSTANT::NS->{$prefix}) { } 5 0 5
95 5 $node->add_meta(
96 $fac->create_meta(
97 '-namespaces' => { $prefix => $ns },
98 '-triple' => { $predicate => $value }
99 )
100 );
101 }
102 else {
103 0 $log->warn("No namespace for prefix $prefix");
104 }
105 }
106 }
107 }
108 }
109 1 my $forest = $fac->create_forest;
110 1 $forest->insert($tree);
111 1 return $forest;
112 }
113  
114 =head1 SEE ALSO
115  
116 There is a mailing list at L<https://groups.google.com/forum/#!forum/bio-phylo>
117 for any user or developer questions and discussions.
118  
119 =over
120  
121 =item L<Bio::Phylo::IO>
122  
123 The adjacency parser is called by the L<Bio::Phylo::IO|Bio::Phylo::IO> object.
124 Look there to learn how to parse trees in general
125  
126 =item L<Bio::Phylo::Manual>
127  
128 Also see the manual: L<Bio::Phylo::Manual> and L<http://rutgervos.blogspot.com>
129  
130 =back
131  
132 =head1 CITATION
133  
134 If you use Bio::Phylo in published research, please cite it:
135  
136 B<Rutger A Vos>, B<Jason Caravas>, B<Klaas Hartmann>, B<Mark A Jensen>
137 and B<Chase Miller>, 2011. Bio::Phylo - phyloinformatic analysis using Perl.
138 I<BMC Bioinformatics> B<12>:63.
139 L<http://dx.doi.org/10.1186/1471-2105-12-63>
140  
141 =cut
142  
143 1 1;
« Phylo/Forest/DrawTreeRole.pm ↑ Summary Phylo/Unparsers/Cdao.pm »