annotate variant_effect_predictor/Bio/EnsEMBL/DBSQL/CompressedSequenceAdaptor.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 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::DBSQL::CompressedSequenceAdaptor - Facilitates DB storage and retrieval of compressed sequence
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 $seq_adptr = $database_adaptor->get_SequenceAdaptor();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29 $dna =
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 ${ $seq_adptr->fetch_by_Slice_start_end_strand( $slice, 1, 1000,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 -1 ) };
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 An adaptor for the retrieval of compressed DNA sequence from the EnsEMBL
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36 database
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38 =head1 METHODS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42 package Bio::EnsEMBL::DBSQL::CompressedSequenceAdaptor;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44 use vars qw(@ISA);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47 use Bio::EnsEMBL::DBSQL::SequenceAdaptor;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49 @ISA = qw(Bio::EnsEMBL::DBSQL::SequenceAdaptor);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52 sub _fetch_seq {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 my $seq_region_id = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55 my $start = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56 my $len = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58 #calculate the offset and start in the compressed sequence
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59 my $comp_start = ($start-1 >> 2) + 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60 my $comp_len = ($len >> 2) + 2;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 my ($bvector, $nline);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 my $sth = $self->prepare(
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65 "SELECT SUBSTRING( d.sequence, ?, ?), n_line
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 FROM dnac d
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67 WHERE d.seq_region_id = ?");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68 $sth->bind_param(1,$comp_start,SQL_INTEGER);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69 $sth->bind_param(2,$comp_len ,SQL_INTEGER);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70 $sth->bind_param(3,$seq_region_id,SQL_INTEGER);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 $sth->execute();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72 $sth->bind_columns(\$bvector, \$nline);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73 $sth->fetch();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74 $sth->finish();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 #convert sequence from binary string to 0123 string
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77 my $bitlen = length($bvector) << 2;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78 my $str = '';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79 for(my $i=0; $i < $bitlen; $i++) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 $str .= vec($bvector, $i, 2);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83 #convert from 0123 to ACTG
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84 $str =~ tr/0123/ACTG/;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86 $str = substr($str, ($start-1)%4, $len);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88 #expand the nlines and place them back in the sequence
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 my @nlines = split(/:/, $nline);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90 foreach my $nl (@nlines) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91 my ($offset,$char,$nlen) = $nl =~ /(\d+)(\D)(\d+)/;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93 #skip nlines entirely out of range
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94 next if(($offset+$nlen-1) < $start || $offset > ($start+$len-1));
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96 #obtain relative offset into requested region
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 $offset = $offset - $start + 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99 #nlines that partially overlap requested region have to be shrunk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100 if($offset < 1) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101 $nlen = $nlen - (1-$offset);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102 $offset = 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 if($offset + $nlen > $start+$len) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105 $nlen = $len - $offset + 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108 substr($str,$offset-1,$nlen) = $char x $nlen;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111 return \$str;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 =head2 store
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117 Arg [1] : string $seq_region_id the id of the sequence region this dna
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118 will be associated with.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119 Arg [2] : string reference $sequence the dna sequence to be stored in
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120 the database
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
121 Example : $dbID = $seq_adaptor->store(12,\'ACTGGGTACCAAACAAACACAACA');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
122 Description: stores a dna sequence in the databases dna table and returns the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
123 database identifier for the new record.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
124 Returntype : int
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
125 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
126 Caller : Bio::EnsEMBL::DBSQL::RawContigAdaptor::store
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
127 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
128
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
129 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
130
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
131 sub store {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
132 my ($self, $seq_region_id, $sequence) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
133
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
134 if(!$seq_region_id) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
135 throw('seq_region_id is required');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
136 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
137
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
138 $sequence = uc($sequence);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
139
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
140 my $bvector = '';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
141
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
142 #convert sequence to 0s,1s,2s and 3s
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
143 $sequence =~ tr/ACTG/0123/;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
144
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
145 #nlines cover sequence which is not ACTG such as N
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
146 #nline format is a set of colon delimited int, char, int triplets:
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
147 #<offset><code><length>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
148 my($nline_char,$nline_len,$nline_off);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
149 my @nlines;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
150
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
151 my $len = length($sequence);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
152 for(my $i=0; $i < $len; $i++) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
153 my $char = substr($sequence,$i,1);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
154
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
155 #quickly check if this character was an A,C,T or G (and was converted to
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
156 # a 0,1,2,3)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
157 if($char =~ /[0-3]/) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
158 vec($bvector, $i,2) = $char;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
159 if($nline_char) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
160 #end of an nline
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
161 push @nlines, "$nline_off$nline_char$nline_len";
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
162 $nline_char = undef;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
163 $nline_len = 0;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
164 $nline_off = 0;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
165 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
166 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
167 #this was not an ACTG
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
168 if($nline_char) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
169 if($nline_char eq $char) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
170 #continuation of an nline
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
171 $nline_len++;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
172 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
173 #end of a previous nline and start of a new one
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
174 push @nlines, "$nline_off$nline_char$nline_len";
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
175 $nline_char = $char;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
176 $nline_len = 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
177 $nline_off = $i+1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
178 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
179 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
180 #start of a new nline
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
181 $nline_char = $char;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
182 $nline_len = 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
183 $nline_off = $i+1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
184 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
185 $char = 0; #need to put numeric val into bitvector despite nline
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
186 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
187
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
188 vec($bvector, $i,2) = $char;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
189 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
190
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
191 my $nline = join(':', @nlines);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
192 my $statement = $self->prepare(
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
193 "INSERT INTO dnac(seq_region_id, sequence, n_line) VALUES(?,?,?)");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
194
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
195 $statement->bind_param(1,$seq_region_id,SQL_INTEGER);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
196 $statement->bind_param(2,$bvector,SQL_BLOB);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
197 $statement->bind_param(3,$nline,SQL_LONGVARCHAR);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
198 $statement->execute();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
199
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
200 $statement->finish();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
201 return;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
202 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
203
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
204
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
205 1;