annotate variant_effect_predictor/Bio/DB/GFF/Homol.pm @ 0:1f6dce3d34e0

Uploaded
author mahtabm
date Thu, 11 Apr 2013 02:01:53 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1 =head1 NAME
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
2
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
3 Bio::DB::GFF::Homol -- A segment of DNA that is homologous to another
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
4
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
5 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
6
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
7 See L<Bio::DB::GFF>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
8
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
9 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
10
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
11 Bio::DB::GFF::Homol is a named subtype of Bio::DB::GFF::Segment. It
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
12 inherits all the methods of its parent, and was created primarily to
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
13 allow for isa() queries and for compatibility with
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
14 Ace::Sequence::Homol.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
15
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
16 A Homol object is typically returned as the method result of the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
17 Bio::DB::GFF::Feature-E<gt>target() method.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
18
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
19 =head1 METHODS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
20
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
21 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
22
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
23 package Bio::DB::GFF::Homol;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26 use Bio::DB::GFF::Segment;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27 use vars qw(@ISA);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28 @ISA = 'Bio::DB::GFF::Segment';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 =head2 name
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32 Title : name
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 Usage : $name = $homol->name
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34 Function: get the ID of the homology object
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 Returns : a string
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 Status : Public
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 sub name { shift->refseq }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43 =head2 asString
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45 Title : asString
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46 Usage : $name = $homol->asString
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47 Function: same as name(), for operator overloading
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48 Returns : a string
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50 Status : Public
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 sub asString { shift->name }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57 =head2 id
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59 Title : id
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60 Usage : $id = $homol->id
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61 Function: get database ID in class:id format
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 Returns : a string
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 Status : Public
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68 sub id {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70 return "$self->{class}:$self->{name}";
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73 sub new_from_segment {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74 my $package = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75 $package = ref $package if ref $package;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 my $segment = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77 my $new = {};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78 @{$new}{qw(factory sourceseq start stop strand class ref refstart refstrand)}
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79 = @{$segment}{qw(factory sourceseq start stop strand class ref refstart refstrand)};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 return bless $new,__PACKAGE__;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83 =head1 BUGS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85 This module is still under development.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87 =head1 SEE ALSO
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 L<bioperl>, L<Bio::DB::GFF>, L<Bio::DB::RelSegment>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91 =head1 AUTHOR
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93 Lincoln Stein E<lt>lstein@cshl.orgE<gt>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95 Copyright (c) 2001 Cold Spring Harbor Laboratory.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 This library is free software; you can redistribute it and/or modify
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98 it under the same terms as Perl itself.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102 1;