annotate variant_effect_predictor/Bio/Align/Utilities.pm @ 0:2bc9b66ada89 draft default tip

Uploaded
author mahtabm
date Thu, 11 Apr 2013 06:29:17 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
1 # $Id: Utilities.pm,v 1.8 2002/11/11 18:39:19 jason Exp $
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
2 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
3 # BioPerl module for Bio::Align::Utilities
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
4 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
5 # Cared for by Jason Stajich <jason@bioperl.org>
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
6 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
7 # Copyright Jason Stajich
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
8 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
9 # You may distribute this module under the same terms as perl itself
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
10
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
11 # POD documentation - main docs before the code
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
12
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
13 =head1 NAME
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
14
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
15 Bio::Align::Utilities - A collection of utilities regarding converting and manipulating alignment objects
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
16
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
17 =head1 SYNOPSIS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
18
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
19 use Bio::Align::Utilities qw(aa_to_dna_aln);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
20
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
21 my $dna_aln = aa_to_dna_aln($aaaln,\%dnaseqs);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
22
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
23
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
24 =head1 DESCRIPTION
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
25
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
26 This module contains utility methods for manipulating sequence
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
27 alignments ( L<Bio::Align::AlignI>) objects.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
28
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
29 The B<aa_to_dna_aln> utility is essentially the same as the B<mrtrans>
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
30 program by Bill Pearson available at
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
31 ftp://ftp.virginia.edu/pub/fasta/other/mrtrans.shar. Of course this
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
32 is a pure-perl implementation, but just to mention that if anything
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
33 seems odd you can check the alignments generated against Bill's
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
34 program.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
35
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
36 =head1 FEEDBACK
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
37
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
38 =head2 Mailing Lists
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
39
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
40 User feedback is an integral part of the evolution of this and other
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
41 Bioperl modules. Send your comments and suggestions preferably to
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
42 the Bioperl mailing list. Your participation is much appreciated.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
43
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
44 bioperl-l@bioperl.org - General discussion
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
45 http://bioperl.org/MailList.shtml - About the mailing lists
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
46
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
47 =head2 Reporting Bugs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
48
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
49 Report bugs to the Bioperl bug tracking system to help us keep track
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
50 of the bugs and their resolution. Bug reports can be submitted via
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
51 email or the web:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
52
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
53 bioperl-bugs@bioperl.org
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
54 http://bugzilla.bioperl.org/
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
55
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
56 =head1 AUTHOR - Jason Stajich
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
57
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
58 Email jason@bioperl.org
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
59
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
60 =head1 CONTRIBUTORS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
61
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
62 Additional contributors names and emails here
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
63
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
64 =head1 APPENDIX
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
65
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
66 The rest of the documentation details each of the object methods.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
67 Internal methods are usually preceded with a _
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
68
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
69 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
70
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
71 #' keep my emacs happy
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
72 # Let the code begin...
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
73
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
74
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
75 package Bio::Align::Utilities;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
76 use vars qw(@ISA @EXPORT @EXPORT_OK);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
77 use strict;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
78 use Carp;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
79 require Exporter;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
80
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
81 @ISA = qw(Exporter);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
82
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
83 @EXPORT = qw();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
84 @EXPORT_OK = qw(aa_to_dna_aln);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
85
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
86 use constant CODONSIZE => 3;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
87
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
88 =head2 aa_to_dna_aln
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
89
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
90 Title : aa_to_dna_aln
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
91 Usage : my $dnaaln = aa_to_dna_aln($aa_aln, \%seqs);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
92 Function: Will convert an AA alignment to DNA space given the
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
93 corresponding DNA sequences. Note that this method expects
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
94 the DNA sequences to be in frame +1 (GFF frame 0) as it will
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
95 start to project into coordinates starting at the first base of
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
96 the DNA sequence, if this alignment represents a different
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
97 frame for the cDNA you will need to edit the DNA sequences
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
98 to remove the 1st or 2nd bases (and revcom if things should be).
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
99 Returns : Bio::Align::AlignI object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
100 Args : 2 arguments, the alignment and a hashref.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
101 Alignment is a Bio::Align::AlignI of amino acid sequences.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
102 The hash reference should have keys which are
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
103 the display_ids for the aa
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
104 sequences in the alignment and the values are a
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
105 Bio::PrimarySeqI object for the corresponding
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
106 spliced cDNA sequence.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
107
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
108 See also: L<Bio::Align::AlignI>, L<Bio::SimpleAlign>, L<Bio::PrimarySeq>
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
109
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
110 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
111
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
112 sub aa_to_dna_aln {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
113 my ($aln,$dnaseqs) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
114 unless( defined $aln &&
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
115 ref($aln) &&
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
116 $aln->isa('Bio::Align::AlignI') ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
117 croak('Must provide a valid Bio::Align::AlignI object as the first argument to aa_to_dna_aln, see the documentation for proper usage and the method signature');
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
118 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
119 my $alnlen = $aln->length;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
120 #print "HSP length is $alnlen\n";
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
121 my $dnaalign = new Bio::SimpleAlign;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
122 foreach my $seq ( $aln->each_seq ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
123 my $newseq;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
124 my $dnaseq = $dnaseqs->{$seq->display_id} || croak("cannot find ".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
125 $seq->display_id);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
126 foreach my $pos ( 1..$alnlen ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
127 my $loc = $seq->location_from_column($pos);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
128 my $dna = '';
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
129 if( !defined $loc || $loc->location_type ne 'EXACT' ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
130 $dna = '---';
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
131 } else {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
132 # To readjust to codon boundaries
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
133 # end needs to be +1 so we can just multiply by CODONSIZE
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
134 # to get this
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
135
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
136 my ($start,$end) = ((($loc->start - 1)* CODONSIZE) +1,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
137 ($loc->end)* CODONSIZE);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
138
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
139 if( $start <=0 || $end > $dnaseq->length() ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
140 print STDERR "start is ", $loc->start, " end is ", $loc->end, " while dnaseq length is ", $dnaseq->length(), " and start/end projected are $start,$end \n";
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
141 warn("codons don't seem to be matching up for $start,$end");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
142 $dna = '---';
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
143 } else {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
144 $dna = $dnaseq->subseq($start,$end);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
145 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
146 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
147 $newseq .= $dna;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
148 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
149 # funky looking math is to readjust to codon boundaries and deal
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
150 # with fact that sequence start with 1
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
151 my $newdna = new Bio::LocatableSeq(-display_id => $seq->id(),
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
152 -start => (($seq->start - 1) *
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
153 CODONSIZE) + 1,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
154 -end => ($seq->end * CODONSIZE),
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
155 -strand => $seq->strand,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
156 -seq => $newseq);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
157 $dnaalign->add_seq($newdna);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
158 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
159 return $dnaalign;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
160 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
161 1;