Bio/Search/Result/WABAResult.pm

filter: Statementstmt 100% 17 / 17 Branchbran 75.0% 3 / 4 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 4 / 4 Podpod 100% 2 / 2 totaltotal 96.3% 26 / 27 CC 3 SCAR 5.1
CC
3
Cov
95%
new
2.0
query_database
2.0
BEGIN
1.0
CRAP 1.7
« Bio/HandlerBaseI.pm ↑ Summary Bio/Matrix/PSM/PsmHeaderI.pm »
1 #
2 # BioPerl module for Bio::Search::Result::WABAResult
3 #
4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
5 #
6 # Cared for by Jason Stajich <jason@bioperl.org>
7 #
8 # Copyright Jason Stajich
9 #
10 # You may distribute this module under the same terms as perl itself
11  
12 # POD documentation - main docs before the code
13  
14 =head1 NAME
15  
16 Bio::Search::Result::WABAResult - Result object for WABA alignment output
17  
18 =head1 SYNOPSIS
19  
20 # use this object exactly as you would a GenericResult
21 # the only extra method is query_database which is the
22 # name of the file where the query sequence came from
23  
24 =head1 DESCRIPTION
25  
26 This object is for WABA result output, there is little difference
27 between this object and a GenericResult save the addition of one
28 method query_database. Expect many of the fields for GenericResult to
29 be empty however as WABA was not intended to provide a lot of extra
30 information other than the alignment.
31  
32 =head1 FEEDBACK
33  
34 =head2 Mailing Lists
35  
36 User feedback is an integral part of the evolution of this and other
37 Bioperl modules. Send your comments and suggestions preferably to
38 the Bioperl mailing list. Your participation is much appreciated.
39  
40 bioperl-l@bioperl.org - General discussion
41 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
42  
43 =head2 Support
44  
45 Please direct usage questions or support issues to the mailing list:
46  
47 I<bioperl-l@bioperl.org>
48  
49 rather than to the module maintainer directly. Many experienced and
50 reponsive experts will be able look at the problem and quickly
51 address it. Please include a thorough description of the problem
52 with code and data examples if at all possible.
53  
54 =head2 Reporting Bugs
55  
56 Report bugs to the Bioperl bug tracking system to help us keep track
57 of the bugs and their resolution. Bug reports can be submitted via the
58 web:
59  
60 https://github.com/bioperl/bioperl-live/issues
61  
62 =head1 AUTHOR - Jason Stajich
63  
64 Email jason@bioperl.org
65  
66 =head1 APPENDIX
67  
68 The rest of the documentation details each of the object methods.
69 Internal methods are usually preceded with a _
70  
71 =cut
72  
73  
74 # Let the code begin...
75  
76  
77 package Bio::Search::Result::WABAResult;
78 2 $Bio::Search::Result::WABAResult::VERSION = '1.7.8';
79 2 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
80  
81  
82 2 ▶use base qw(Bio::Search::Result::GenericResult);
Subroutine BEGIN: called CC=1 SCAR=0.0
83  
84 =head2 new
85  
86 Title : new
87 Usage : my $obj = Bio::Search::Result::WABAResult->new();
88 Function: Builds a new Bio::Search::Result::WABAResult object
89 Returns : Bio::Search::Result::WABAResult
90 Args : -query_database => "name of the database where the query came from"
91  
92  
93 =cut
94  
95 2 ▶sub new {
Subroutine new: called CC=2 SCAR=7.0
Pod documented
96 2 my($class,@args) = @_;
97  
98 2 my $self = $class->SUPER::new(@args);
99 2 my ($db) = $self->_rearrange([qw(QUERY_DATABASE)], @args);
100 2 ▶ defined $db && $self->query_database($db);
Branch: 1 branch
BranchTrueFalseTotal
defined $db and $self->query_database($db) 2 0 2
101 2 return $self;
102 }
103  
104 =head2 query_database
105  
106 Title : query_database
107 Usage : $obj->query_database($newval)
108 Function: Data field for the database filename where the
109 query sequence came from
110 Returns : value of query_database
111 Args : newvalue (optional)
112  
113  
114 =cut
115  
116 4 ▶sub query_database{
Subroutine query_database: called CC=2 SCAR=6.9
Pod documented
117 4 my ($self,$value) = @_;
118 4 ▶ if( defined $value) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $value) 2 2 4
119 2 $self->{'query_database'} = $value;
120 }
121 4 return $self->{'query_database'};
122 }
123  
124  
125 =head2 All other methods are inherited from Bio::Search::Result::GenericResult
126  
127 See the L<Bio::Search::Result::GenericResult> for complete
128 documentation of the rest of the methods that are available for this
129 module.
130  
131 =cut
132  
133 2 1;
« Bio/HandlerBaseI.pm ↑ Summary Bio/Matrix/PSM/PsmHeaderI.pm »