annotate variant_effect_predictor/Bio/EnsEMBL/SeqRegionSynonym.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 =head1 LICENSE
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
2
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
4 Genome Research Limited. All rights reserved.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
5
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
6 This software is distributed under a modified Apache license.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
7 For license details, please see
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
8
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
9 http://www.ensembl.org/info/about/code_licence.html
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
10
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
11 =head1 CONTACT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
12
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
13 Please email comments or questions to the public Ensembl
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
14 developers list at <dev@ensembl.org>.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
15
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
16 Questions may also be sent to the Ensembl help desk at
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
17 <helpdesk@ensembl.org>.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
18
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
19 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21 =head1 NAME
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23 Bio::EnsEMBL::SeqRegionSynonym -
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24 Object representing an alternatice name.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26 =head1 SYNOPSIS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30 This object holds information about alternative name to
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31 Ensembl seq regions.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33 =head1 METHODS
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 package Bio::EnsEMBL::SeqRegionSynonym;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40 use warnings;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 no warnings qw(uninitialized);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43 use Bio::EnsEMBL::Storable;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44 use Bio::Annotation::DBLink;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46 use Bio::EnsEMBL::Utils::Argument qw(rearrange);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 use Bio::EnsEMBL::Utils::Exception qw(deprecate);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 our @ISA = qw(Bio::EnsEMBL::Storable);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51 =head2 new
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53 Args [...] : list of named parameters
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 Example : my $srs = new Bio::EnsEMBL::SeqRegionSynonym(
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55 -adaptor => $adaptor,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 -synonym => $alt_name,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 -external_db_id => 1234
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58 -seq_region_id => 12);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59 Description: Creates a new SeqRegionSynonym object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60 Returntype : Bio::EnsEMBL::SeqRegionSynonym
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 Caller : Bio::EnsEMBL::SeqRegionSynonymAdaptor
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 sub new {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67 my ($class, @args) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69 my $self = bless {},$class;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 my ( $adaptor, $synonym, $ex_db, $seq_region_id, $dbid) =
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 rearrange ( ['ADAPTOR','SYNONYM','EXTERNAL_DB_ID','SEQ_REGION_ID','DBID'], @args );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74 $self->adaptor($adaptor);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76 if( defined $ex_db ) { $self->external_db_id( $ex_db ) }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77 if( defined $seq_region_id ) { $self->seq_region_id( $seq_region_id ) }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 if (defined $dbid) { $self->{'dbID'} = $dbid}
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80 if( defined $synonym ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 $self->name( $synonym ) ;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 } else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83 warn "No alternative name given\n";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 return undef;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87 return $self;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90 sub name{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92 $self->{'name'} = shift if(@_);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93 return $self->{'name'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96 sub external_db_id{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98 $self->{'ex_db'} = shift if(@_);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99 return $self->{'ex_db'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102 sub seq_region_id{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104 $self->{'seq_region_id'} = shift if(@_);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105 return $self->{'seq_region_id'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108 1;