|
0
|
1 # $Id: FeatureI.pm,v 1.3 2002/10/30 23:15:23 allenday Exp $
|
|
|
2 # BioPerl module for Bio::Expression::FeatureI
|
|
|
3 #
|
|
|
4 # Copyright Allen Day <allenday@ucla.edu>, Stan Nelson <snelson@ucla.edu>
|
|
|
5 # Human Genetics, UCLA Medical School, University of California, Los Angeles
|
|
|
6
|
|
|
7 # POD documentation - main docs before the code
|
|
|
8
|
|
|
9 =head1 NAME
|
|
|
10
|
|
|
11 Bio::Expression::FeatureI - an interface class for DNA/RNA features
|
|
|
12
|
|
|
13 =head1 SYNOPSIS
|
|
|
14
|
|
|
15 Do not use this module directly
|
|
|
16
|
|
|
17 =head1 DESCRIPTION
|
|
|
18
|
|
|
19 This provides a standard bioperl interface class for representing
|
|
|
20 DNA and RNA features. It cannot be instantiated directly, but serves
|
|
|
21 as an abstract base class for implementors.
|
|
|
22
|
|
|
23 =head1 FEEDBACK
|
|
|
24
|
|
|
25 =head2 Mailing Lists
|
|
|
26
|
|
|
27 User feedback is an integral part of the evolution of this and other
|
|
|
28 Bioperl modules. Send your comments and suggestions preferably to one
|
|
|
29 of the Bioperl mailing lists. Your participation is much appreciated.
|
|
|
30
|
|
|
31 bioperl-l@bioperl.org - General discussion
|
|
|
32 http://bioperl.org/MailList.shtml - About the mailing lists
|
|
|
33
|
|
|
34 =head2 Reporting Bugs
|
|
|
35
|
|
|
36 Report bugs to the Bioperl bug tracking system to help us keep track
|
|
|
37 the bugs and their resolution.
|
|
|
38 Bug reports can be submitted via email or the web:
|
|
|
39
|
|
|
40 bioperl-bugs@bio.perl.org
|
|
|
41 http://bugzilla.bioperl.org/
|
|
|
42
|
|
|
43 =head1 AUTHOR
|
|
|
44
|
|
|
45 Allen Day E<lt>allenday@ucla.eduE<gt>
|
|
|
46
|
|
|
47 =head1 APPENDIX
|
|
|
48
|
|
|
49 The rest of the documentation details each of the object
|
|
|
50 methods. Internal methods are usually preceded with a _
|
|
|
51
|
|
|
52 =cut
|
|
|
53
|
|
|
54 # Let the code begin...
|
|
|
55 package Bio::Expression::FeatureI;
|
|
|
56
|
|
|
57 use strict;
|
|
|
58 use Bio::Root::Root;
|
|
|
59
|
|
|
60 use base qw(Bio::Root::Root Bio::PrimarySeqI);
|
|
|
61 use vars qw($DEBUG);
|
|
|
62
|
|
|
63 =head2 quantitation()
|
|
|
64
|
|
|
65 Title : value
|
|
|
66 Usage : $val = $ftr->quantitation()
|
|
|
67 Function: get/set the feature's quantitation
|
|
|
68 Returns : A numeric value
|
|
|
69 Args : a new numeric value (optional)
|
|
|
70
|
|
|
71 =cut
|
|
|
72
|
|
|
73 sub quantitation {
|
|
|
74 shift->throw_not_implemented();
|
|
|
75 }
|
|
|
76
|
|
|
77 =head2 quantitation_units()
|
|
|
78
|
|
|
79 Title : quantitation_units
|
|
|
80 Usage : $units = $ftr->quantitation_units()
|
|
|
81 Function: get/set the units of the feature's quantitation
|
|
|
82 Returns : A string or undef
|
|
|
83 Args : a new string (optional)
|
|
|
84
|
|
|
85 =cut
|
|
|
86
|
|
|
87 sub quantitation_units {
|
|
|
88 shift->throw_not_implemented();
|
|
|
89 }
|
|
|
90
|
|
|
91 =head2 standard_deviation()
|
|
|
92
|
|
|
93 Title : standard_deviation
|
|
|
94 Usage : $std_dev = $ftr->standard_deviation()
|
|
|
95 Function: get/set the feature's standard deviation of quantitation()
|
|
|
96 Returns : A numeric value
|
|
|
97 Args : a new numeric value (optional)
|
|
|
98 Comments: no calculation is done here
|
|
|
99
|
|
|
100 =cut
|
|
|
101
|
|
|
102 sub standard_deviation {
|
|
|
103 shift->throw_not_implemented();
|
|
|
104 }
|
|
|
105
|
|
|
106 =head2 sample_count()
|
|
|
107
|
|
|
108 Title : sample_count
|
|
|
109 Usage : $sample_count = $ftr->sample_count()
|
|
|
110 Function: get/set the number of samples used to calculate
|
|
|
111 quantitation()
|
|
|
112 Returns : An integer
|
|
|
113 Args : a new integer (optional)
|
|
|
114
|
|
|
115 =cut
|
|
|
116
|
|
|
117 sub sample_count {
|
|
|
118 shift->throw_not_implemented();
|
|
|
119 }
|
|
|
120
|
|
|
121 1;
|
