annotate variant_effect_predictor/Bio/EnsEMBL/IdMapping/TinyTranslation.pm @ 2:a5976b2dce6f

changing defualt values for ensembl database
author mahtabm
date Thu, 11 Apr 2013 17:15:42 +1000
parents 1f6dce3d34e0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1 =head1 LICENSE
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
2
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
4 Genome Research Limited. All rights reserved.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
5
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
6 This software is distributed under a modified Apache license.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
7 For license details, please see
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
8
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
9 http://www.ensembl.org/info/about/code_licence.html
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
10
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
11 =head1 CONTACT
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
12
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
13 Please email comments or questions to the public Ensembl
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
14 developers list at <dev@ensembl.org>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
15
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
16 Questions may also be sent to the Ensembl help desk at
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
17 <helpdesk@ensembl.org>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
18
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
19 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
20
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
21 =head1 NAME
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
22
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
23 Bio::EnsEMBL::IdMapping::TinyTranslation - lightweight translation object
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27 if ( my $tl = $tr->translation ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28 my $lightweight_tl =
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29 Bio::EnsEMBL::IdMapping::TinyTranslation->new_fast( [
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 $tl->dbID, $tl->stable_id,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 $tl->version, $tl->created_date,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32 $tl->modified_date, $tr->dbID,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 $tr->translate->seq, ( $tr->is_known ? 1 : 0 ),
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34 ] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39 This is a lightweight translation object for the stable Id mapping. See
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 the documentation in TinyFeature for general considerations about its
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 design.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43 =head1 METHODS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45 transcript_id
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46 seq
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47 is_known
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51 package Bio::EnsEMBL::IdMapping::TinyTranslation;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 # internal data structure (array indices):
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55 # 0-4 see TinyFeature
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56 # 5 transcript_id
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57 # 6 seq
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58 # 7 is_known
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 use warnings;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63 no warnings 'uninitialized';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65 use Bio::EnsEMBL::IdMapping::TinyFeature;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 our @ISA = qw(Bio::EnsEMBL::IdMapping::TinyFeature);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68 use Bio::EnsEMBL::Utils::Exception qw(throw warning);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 =head2 transcript_id
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73 Arg[1] : (optional) Int - the transcript internal Id ("dbID")
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74 Description : Getter/setter for the transcript internal Id this translation is
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75 attached to.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 Return type : Int
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79 Status : At Risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 : under development
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84 sub transcript_id {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86 $self->[5] = shift if (@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87 return $self->[5];
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91 =head2 seq
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93 Arg[1] : (optional) String - the translation's sequence
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94 Description : Getter/setter for the translation's sequence.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95 Return type : String
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98 Status : At Risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99 : under development
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103 sub seq {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105 $self->[6] = shift if (@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 return $self->[6];
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110 =head2 is_known
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112 Arg[1] : (optional) Boolean - the translation's "known" status
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113 Description : Getter/setter for the translation's "known" status.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114 Return type : Boolean
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117 Status : At Risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118 : under development
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
121
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
122 sub is_known {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
123 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
124 $self->[7] = shift if (@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
125 return $self->[7];
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
126 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
127
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
128
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
129 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
130