Bio/Seq/LargeSeqI.pm

filter: Statementstmt 80.0% 8 / 10 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 66.6% 2 / 3 Podpod 100% 1 / 1 totaltotal 78.5% 11 / 14 CC 1 SCAR 2.9
CC
1
Cov
80%
add_sequence_as_string
2.0
BEGIN
1.0
BEGIN
1.0
CRAP 1.3
« Bio/Location/FuzzyLocationI.pm ↑ Summary Bio/SeqFeature/Gene/Promoter.pm »
1 #
2 # BioPerl module for Bio::Seq::LargeSeqI
3 #
4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
5 #
6 # Cared for by Albert Vilella
7 #
8 # Copyright Albert Vilella
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::Seq::LargeSeqI - Interface class for sequences that cache their
17 residues in a temporary file
18  
19 =head1 SYNOPSIS
20  
21 #
22  
23 =head1 DESCRIPTION
24  
25 The interface class defines a group of sequence classes that do not
26 keep their sequence information in memory but store it in a file. This
27 makes it possible to work with very large files even with limited RAM.
28  
29 The most important consequence of file caching for sequences is that
30 you do not want to inspect the sequence unless absolutely
31 necessary. These sequences typically override the length() method not
32 to check the sequence.
33  
34 The seq() method is not resettable, if you want to add to the end of the
35 sequence you have to use add_sequence_as_string(), for any other sequence changes you'll
36 have to create a new object.
37  
38 =head1 FEEDBACK
39  
40 =head2 Mailing Lists
41  
42 User feedback is an integral part of the evolution of this and other
43 Bioperl modules. Send your comments and suggestions preferably to
44 the Bioperl mailing list. Your participation is much appreciated.
45  
46 bioperl-l@bioperl.org - General discussion
47 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
48  
49 =head2 Support
50  
51 Please direct usage questions or support issues to the mailing list:
52  
53 I<bioperl-l@bioperl.org>
54  
55 rather than to the module maintainer directly. Many experienced and
56 reponsive experts will be able look at the problem and quickly
57 address it. Please include a thorough description of the problem
58 with code and data examples if at all possible.
59  
60 =head2 Reporting Bugs
61  
62 Report bugs to the Bioperl bug tracking system to help us keep track
63 of the bugs and their resolution. Bug reports can be submitted via
64 email or the web:
65  
66 https://github.com/bioperl/bioperl-live/issues
67  
68 =head1 AUTHOR - Albert Vilella
69  
70 Email avilella-AT-gmail-DOT-com
71  
72 =head1 CONTRIBUTORS
73  
74 Heikki Lehvaslaiho, heikki-at-bioperl-dot-org
75  
76 =head1 APPENDIX
77  
78 The rest of the documentation details each of the object methods.
79 Internal methods are usually preceded with a _
80  
81 =cut
82  
83  
84 # Let the code begin...
85  
86  
87 package Bio::Seq::LargeSeqI;
88 9 $Bio::Seq::LargeSeqI::VERSION = '1.7.8';
89 9 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
90  
91  
92 9 ▶use base qw(Bio::Root::RootI);
Subroutine BEGIN: called CC=1 SCAR=0.0
93  
94  
95 =head2 add_sequence_as_string
96  
97 Title : add_sequence_as_string
98 Usage : $seq->add_sequence_as_string("CATGAT");
99 Function: Appends additional residues to an existing object.
100 This allows one to build up a large sequence without
101 storing entire object in memory.
102 Returns : Current length of sequence
103 Args : string to append
104  
105 =cut
106  
107 0 ▶sub add_sequence_as_string {
Subroutine add_sequence_as_string: not called CC=1 SCAR=6.9
Pod documented
108 0 my ($self) = @_;
109 0 $self->throw_not_implemented();
110 }
111  
112  
113 9 1;
« Bio/Location/FuzzyLocationI.pm ↑ Summary Bio/SeqFeature/Gene/Promoter.pm »