annotate variant_effect_predictor/Bio/Tools/AlignFactory.pm @ 0:21066c0abaf5 draft

Uploaded
author willmclaren
date Fri, 03 Aug 2012 10:04:48 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
1 # $Id: AlignFactory.pm,v 1.8 2001/11/20 02:09:40 lstein Exp $
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
2 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
3 # BioPerl module for Bio::Tools::AlignFactory
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
4 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
5 # Cared for by Ewan Birney <birney@sanger.ac.uk>
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
6 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
7 # Copyright Ewan Birney
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
8 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
9 # You may distribute this module under the same terms as perl itself
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
10
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
11 # POD documentation - main docs before the code
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
12
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
13 =head1 NAME
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
14
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
15 Bio::Tools::AlignFactory - Base object for alignment factories
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
16
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
17 =head1 SYNOPSIS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
18
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
19 You wont be using this as an object, but using a dervied class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20 like Bio::Tools::pSW
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24 Holds common Alignment Factory attributes in place
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26 =head1 CONTACT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28 http://bio.perl.org/ or birney@sanger.ac.uk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30 =head1 APPENDIX
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 The rest of the documentation details each of the object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33 methods. Internal methods are usually preceded with a _
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38 # Let the code begin...
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40 package Bio::Tools::AlignFactory;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 use vars qw(@ISA);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44 use Bio::Root::Root;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45 @ISA = qw(Bio::Root::Root);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 BEGIN {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48 eval {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 require Bio::Ext::Align;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50 };
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51 if ( $@ ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52 print STDERR ("\nThe C-compiled engine for Smith Waterman alignments (Bio::Ext::Align) has not been installed.\n Please install the bioperl-ext package\n\n");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53 exit(1);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 sub new {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58 my($class,@args) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59 my $self = $class->SUPER::new(@args);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60 $self->_initialize(@args);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61 # set up defaults
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63 $self->{'kbyte'} = 20000;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 $self->{'report'} = 0;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65 return $self;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69 =head2 kbyte
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 Title : kbyte()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 Usage : set/gets the amount of memory able to be used
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73 Function :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74 : $factory->kbyte(200);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75 :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76 Returns :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77 Argument : memory in kilobytes
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 sub kbyte {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 my ($self,$value) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 if( defined $value ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 $self->{'kbyte'} = $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87 return $self->{'kbyte'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 =head2 report
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93 Title : report()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94 Usage : set/gets the report boolean to issue reports or not
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95 Function :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96 : $factory->report(1); # reporting goes on
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98 Returns : n/a
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99 Argument : 1 or 0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 sub report {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104 my ($self,$value) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107 if( defined $value ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108 if( $value != 1 && $value != 0 ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 $self->throw("Attempting to modify AlignFactory Report with no boolean value!");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111 $self->{'report'} = $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114 return $self->{'report'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 =head2 set_memory_and_report
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119 Title : set_memory_and_report
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120 Usage : Only used by subclasses.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121 Function:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123 Returns :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
129 sub set_memory_and_report{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
130 my ($self) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
131
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
132 if( $self->{'kbyte'} < 5 ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
133 $self->throw("You can suggest aligning things with less than 5kb");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
134 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
135
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
136 &Bio::Ext::Align::change_max_BaseMatrix_kbytes($self->{'kbyte'});
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
137
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
138 if( $self->{'report'} == 0 ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
139 &Bio::Ext::Align::error_off(16);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
140 } else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
141 &Bio::Ext::Align::error_on(16);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
142 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
143 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
144
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
145 1;