annotate variant_effect_predictor/Bio/Tools/Prediction/Gene.pm @ 1:d6778b5d8382 draft default tip

Deleted selected files
author willmclaren
date Fri, 03 Aug 2012 10:05:43 -0400
parents 21066c0abaf5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
1 # $Id: Gene.pm,v 1.8 2002/10/22 07:38:48 lapp Exp $
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
2 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
3 # BioPerl module for Bio::Tools::Prediction::Gene
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
4 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
5 # Cared for by Hilmar Lapp <hlapp@gmx.net>
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
6 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
7 # Copyright Hilmar Lapp
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::Prediction::Gene - a predicted gene structure feature
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 See documentation of methods.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23 A feature representing a predicted gene structure. This class actually
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24 inherits off Bio::SeqFeature::Gene::Transcript and therefore has all that
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25 functionality, plus a few methods supporting predicted sequence features,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26 like a predicted CDS and a predicted translation.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28 Exons held by an instance of this class will usually be instances of
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29 Bio::Tools::Prediction::Exon, although they do not have to be. Refer to the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30 documentation of the class that produced the instance.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 Normally, you will not want to create an instance of this class yourself.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33 Instead, classes representing the results of gene structure prediction
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34 programs will do that.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36 =head1 FEEDBACK
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38 =head2 Mailing Lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40 User feedback is an integral part of the evolution of this and other
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 Bioperl modules. Send your comments and suggestions preferably to one
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42 of the Bioperl mailing lists. Your participation is much appreciated.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44 bioperl-l@bioperl.org - General discussion
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45 http://bio.perl.org/MailList.html - About the mailing lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 =head2 Reporting Bugs
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 Report bugs to the Bioperl bug tracking system to help us keep track
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50 the bugs and their resolution. Bug reports can be submitted via email
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51 or the web:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53 bioperl-bugs@bio.perl.org
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 http://bugzilla.bioperl.org/
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 =head1 AUTHOR - Hilmar Lapp
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58 Email hlapp@gmx.net or hilmar.lapp@pharma.novartis.com
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60 Describe contact details here
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 =head1 APPENDIX
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69 # Let the code begin...
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 package Bio::Tools::Prediction::Gene;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73 use vars qw(@ISA);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76 use Bio::SeqFeature::Gene::Transcript;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79 @ISA = qw(Bio::SeqFeature::Gene::Transcript);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 sub new {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 my($class,@args) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 my $self = $class->SUPER::new(@args);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86 my ($primary) = $self->_rearrange([qw(PRIMARY)],@args);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88 $primary = 'predicted_gene' unless $primary;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89 $self->primary_tag($primary);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90 return $self;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94 =head2 predicted_cds
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96 Title : predicted_cds
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 Usage : $predicted_cds_dna = $gene->predicted_cds();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98 $gene->predicted_cds($predicted_cds_dna);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99 Function: Get/Set the CDS (coding sequence) as predicted by a program.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101 This method is independent of an attached_seq. There is no
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102 guarantee whatsoever that the returned CDS has anything to do
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 (e.g., matches) with the sequence covered by the exons as annotated
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104 through this object.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107 Returns : A Bio::PrimarySeqI implementing object holding the DNA sequence
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108 defined as coding by a prediction of a program.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 Args : On set, a Bio::PrimarySeqI implementing object holding the DNA
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 sequence defined as coding by a prediction of a program.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114 sub predicted_cds {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115 my ($self, $cds) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 if(defined($cds)) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118 $self->{'_predicted_cds'} = $cds;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120 return $self->{'_predicted_cds'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123 =head2 predicted_protein
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125 Title : predicted_protein
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126 Usage : $predicted_protein_seq = $gene->predicted_protein();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127 $gene->predicted_protein($predicted_protein_seq);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128 Function: Get/Set the protein translation as predicted by a program.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
129
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
130 This method is independent of an attached_seq. There is no
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
131 guarantee whatsoever that the returned translation has anything to
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
132 do with the sequence covered by the exons as annotated
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
133 through this object, or the sequence returned by predicted_cds(),
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
134 although it should usually be just the standard translation.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
135
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
136 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
137 Returns : A Bio::PrimarySeqI implementing object holding the protein
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
138 translation as predicted by a program.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
139 Args : On set, a Bio::PrimarySeqI implementing object holding the protein
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
140 translation as predicted by a program.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
141
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
142 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
143
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
144 sub predicted_protein {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
145 my ($self, $aa) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
146
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
147 if(defined($aa)) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
148 $self->{'_predicted_aa'} = $aa;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
149 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
150 return $self->{'_predicted_aa'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
151 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
152
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
153 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
154 # Everything else is just inherited from SeqFeature::GeneStructure.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
155 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
156
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
157 1;