annotate variant_effect_predictor/Bio/Assembly/Scaffold.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: Scaffold.pm,v 1.2 2002/11/11 18:16:30 lapp Exp $
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
2 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
3 # BioPerl module for Bio::Assembly::Scaffold
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
4 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
5 # Copyright by Robson F. de Souza
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
6 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
7 # You may distribute this module under the same terms as perl itself
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
8 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
9 # POD documentation - main docs before the code
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
10
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
11 =head1 NAME
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
12
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
13 Bio::Assembly::Scaffold - Perl module to hold and manipulate sequence assembly data.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
14
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
15 =head1 SYNOPSYS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
16
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
17 # Module loading
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
18 use Bio::Assembly::IO;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
19
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
20 # Assembly loading methods
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
21 my $aio = new Bio::Assembly::IO(-file=>"test.ace.1", -format=>'phrap');
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
22 my $assembly = $aio->next_assembly;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
23
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
24 foreach my $contig ($assembly->all_contigs) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
25 # do something... (see Bio::Assembly::Contig)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
26 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
27
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
28 =head1 DESCRIPTION
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
29
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
30 Bio::Assembly::Scaffold was developed to store and manipulate data
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
31 from sequence assembly programs like Phrap. It implements the
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
32 ScaffoldI interface and intends to be generic enough to be used by
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
33 Bio::Assembly::IO drivers written to programs other than Phrap.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
34
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
35 =head1 FEEDBACK
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
36
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
37 =head2 Mailing Lists
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
38
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
39 User feedback is an integral part of the evolution of this and other
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
40 Bioperl modules. Send your comments and suggestions preferably to the
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
41 Bioperl mailing lists Your participation is much appreciated.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
42
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
43 bioperl-l@bioperl.org - General discussion
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
44 http://bio.perl.org/MailList.html - About the mailing lists
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
45
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
46 =head2 Reporting Bugs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
47
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
48 Report bugs to the Bioperl bug tracking system to help us keep track
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
49 the bugs and their resolution. Bug reports can be submitted via email
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
50 or the web:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
51
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
52 bioperl-bugs@bio.perl.org
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
53 http://bugzilla.bioperl.org/
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
54
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
55 =head1 AUTHOR - Robson Francisco de Souza
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
56
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
57 rfsouza@citri.iq.usp.br
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
58
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
59 =head1 APPENDIX
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
60
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
61 The rest of the documentation details each of the object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
62 methods. Internal methods are usually preceded with a _
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
63
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
64 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
65
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
66 package Bio::Assembly::Scaffold;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
67
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
68 use strict;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
69 use vars qw(@ISA $VERSION);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
70
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
71 use Bio::Root::Root;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
72 use Bio::Assembly::ScaffoldI;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
73 use Bio::Annotation::Collection;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
74
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
75 $VERSION = '0.0.1';
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
76 @ISA = qw(Bio::Root::Root Bio::Assembly::ScaffoldI);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
77
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
78 =head2 new ()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
79
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
80 Title : new
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
81 Usage : $assembly = new (-source=>'program_name',
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
82 -contigs=>\@contigs,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
83 -id=>"assembly 1");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
84 Function: creates a new assembly object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
85 Returns :
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
86 Args :
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
87 -source : [string] sequence assembly program
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
88 -contigs : reference to array of
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
89 Bio::Assembly::Contig objects
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
90 -id : [string] assembly name
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
91
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
92 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
93
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
94 sub new {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
95 my($class,@args) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
96
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
97 my $self = $class->SUPER::new(@args);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
98
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
99 my ($src,$contigs,$id) = $self->_rearrange([qw(SOURCE CONTIGS ID)], @args);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
100
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
101 $self->{'_contigs'} = {};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
102 $self->{'_singlets'} = {};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
103 $self->{'_seqs'} = {};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
104 $self->{'_annotation'} = Bio::Annotation::Collection->new();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
105 $self->{'_id'} = 'NoName';
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
106
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
107 if (defined $contigs && ref($contigs = 'ARRAY')) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
108 foreach my $contig (@{$contigs}) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
109 $self->add_contig($contig);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
110 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
111 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
112
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
113 $self->{'_id'} = $id if (defined $id);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
114
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
115 return $self;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
116 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
117
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
118 =head1 Accessing general assembly data
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
119
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
120 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
121
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
122 =head2 id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
123
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
124 Title : id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
125 Usage : $assembly->id()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
126 Function: Get/Set assembly ID
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
127 Returns : string or undef
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
128 Args : string
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
129
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
130 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
131
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
132 sub id {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
133 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
134 my $id = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
135
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
136 $self->{'_id'} = $id if (defined $id);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
137
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
138 return $self->{'_id'};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
139 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
140
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
141 =head2 annotation
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
142
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
143 Title : annotation
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
144 Usage : $assembly->annotation()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
145 Function: Get/Set assembly annotation object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
146 Returns : Bio::Annotation::Collection
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
147 Args : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
148
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
149 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
150
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
151 sub annotation {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
152 my ($self,$ref) = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
153
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
154 $self->{'_annotation'} = $ref if (defined $ref);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
155 return $self->{'_annotation'};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
156 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
157
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
158 =head2 get_nof_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
159
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
160 Title : get_nof_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
161 Usage : $assembly->get_nof_contigs()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
162 Function: Get the number of contigs included in the assembly
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
163 Returns : integer
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
164 Args : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
165
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
166 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
167
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
168 sub get_nof_contigs {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
169 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
170
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
171 return scalar( $self->get_contig_ids() );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
172 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
173
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
174 =head2 get_nof_sequences_in_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
175
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
176 Title : get_nof_sequences_in_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
177 Usage : $assembly->get_nof_sequences_in_contigs()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
178 Function:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
179
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
180 Get the number of sequences included in the
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
181 assembly. This number refers only to the sequences used
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
182 to build contigs in this assembly. It does not includes
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
183 contig consensus sequences or singlets.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
184
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
185 Returns : integer
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
186 Args : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
187
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
188 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
189
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
190 sub get_nof_sequences_in_contigs {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
191 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
192
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
193 my $nof_seqs = 0;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
194 foreach my $contig ($self->all_contigs) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
195 $nof_seqs += scalar( $contig->get_seq_ids() );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
196 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
197
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
198 return $nof_seqs;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
199 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
200
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
201 =head2 get_nof_singlets
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
202
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
203 Title : nof_singlets
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
204 Usage : $assembly->nof_singlets()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
205 Function: Get the number of singlets included in the assembly
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
206 Returns : integer
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
207 Args : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
208
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
209 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
210
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
211 sub get_nof_singlets {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
212 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
213
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
214 return scalar( $self->get_singlet_ids() );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
215 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
216
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
217 =head2 get_seq_ids
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
218
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
219 Title : get_seq_ids
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
220 Usage : $assembly->get_seq_ids()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
221 Function:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
222
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
223 Get the ID of sequences from all contigs. This list
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
224 refers only to the aligned sequences in contigs. It does
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
225 not includes contig consensus sequences or singlets.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
226
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
227 Returns : array of strings
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
228 Args : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
229
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
230 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
231
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
232 sub get_seq_ids {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
233 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
234
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
235 return keys %{ $self->{'_seqs'} };
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
236 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
237
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
238 =head2 get_contig_ids
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
239
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
240 Title : get_contig_ids
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
241 Usage : $assembly->get_contig_ids()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
242 Function: Access list of contig IDs from assembly
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
243 Returns : an array, if there are any contigs in the
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
244 assembly. An empty array otherwise
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
245 Args : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
246
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
247 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
248
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
249 sub get_contig_ids {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
250 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
251
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
252 return sort keys %{$self->{'_contigs'}};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
253 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
254
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
255 =head2 get_singlet_ids
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
256
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
257 Title : get_singlet_ids
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
258 Usage : $assembly->get_singlet_ids()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
259 Function: Access list of singlet IDs from assembly
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
260 Returns : array of strings if there are any singlets
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
261 otherwise an empty array
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
262 Args : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
263
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
264 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
265
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
266 sub get_singlet_ids {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
267 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
268
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
269 return sort keys %{$self->{'_singlets'}};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
270 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
271
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
272 =head2 get_seq_by_id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
273
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
274 Title : get_seq_by_id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
275 Usage : $assembly->get_seq_by_id($id)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
276 Function:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
277
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
278 Get a reference for an aligned sequence
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
279 This sequence must be part of a contig
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
280 in the assembly.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
281
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
282 Returns : a Bio::LocatableSeq object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
283 undef if sequence $id is not found
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
284 in any contig
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
285 Args : [string] sequence identifier (id)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
286
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
287 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
288
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
289 sub get_seq_by_id {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
290 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
291 my $seqID = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
292
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
293 return undef unless (exists $self->{'_seqs'}{$seqID});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
294
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
295 return $self->{'_seqs'}{$seqID}->get_seq_by_name($seqID);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
296 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
297
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
298 =head2 get_contig_by_id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
299
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
300 Title : get_contig_by_id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
301 Usage : $assembly->get_contig_by_id($id)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
302 Function: Get a reference for a contig
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
303 Returns : a Bio::Assembly::Contig object or undef
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
304 Args : [string] contig unique identifier (ID)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
305
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
306 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
307
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
308 sub get_contig_by_id {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
309 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
310 my $contigID = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
311
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
312 return undef unless (exists $self->{'_contigs'}{$contigID});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
313
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
314 return $self->{'_contigs'}{$contigID};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
315 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
316
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
317 =head2 get_singlet_by_id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
318
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
319 Title : get_singlet_by_id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
320 Usage : $assembly->get_singlet_by_id()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
321 Function: Get a reference for a singlet
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
322 Returns : Bio::PrimarySeqI object or undef
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
323 Args : [string] a singlet ID
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
324
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
325 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
326
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
327 sub get_singlet_by_id {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
328 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
329
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
330 my $singletID = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
331
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
332 return undef unless (exists $self->{'_singlets'}{$singletID});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
333
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
334 return $self->{'_singlets'}{$singletID};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
335 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
336
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
337 =head1 Modifier methods
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
338
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
339 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
340
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
341 =head2 add_contig
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
342
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
343 Title : add_contig
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
344 Usage : $assembly->add_contig($contig)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
345 Function: Add a contig to the assembly
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
346 Returns : 1 on success
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
347 Args : a Bio::Assembly::Contig object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
348 order (optional)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
349
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
350 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
351
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
352 sub add_contig {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
353 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
354 my $contig = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
355
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
356 if( !ref $contig || ! $contig->isa('Bio::Assembly::Contig') ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
357 $self->throw("Unable to process non Bio::Assembly::Contig object [", ref($contig), "]");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
358 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
359 my $contigID = $contig->id();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
360 if( !defined $contigID ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
361 $contigID = 'Unknown_' . ($self->get_nof_contigs() + 1);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
362 $contig->id($contigID);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
363 $self->warn("Attributing ID $contigID to unidentified Bio::Assembly::Contig object.");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
364 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
365
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
366 $self->warn("Replacing contig $contigID with a new contig object")
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
367 if (exists $self->{'_contigs'}{$contigID});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
368 $self->{'_contigs'}{$contigID} = $contig;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
369
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
370 foreach my $seqID ($contig->get_seq_ids()) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
371 if (exists $self->{'_seqs'}{$seqID}) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
372 $self->warn( "Sequence $seqID already assigned to contig ".
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
373 $self->{'_seqs'}{$seqID}->id().". Moving to contig $contigID")
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
374 unless ($self->{'_seqs'}{$seqID} eq $contig);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
375 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
376 $self->{'_seqs'}{$seqID} = $contig;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
377 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
378
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
379 return 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
380 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
381
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
382 =head2 add_singlet
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
383
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
384 Title : add_singlet
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
385 Usage : $assembly->add_singlet($seq)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
386 Function: Add a singlet to the assembly
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
387 Returns : 1 on success, 0 otherwise
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
388 Args : a Bio::PrimarySeqI object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
389 order (optional)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
390
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
391 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
392
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
393 sub add_singlet {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
394 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
395 my $singlet = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
396
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
397 if( !ref $singlet || ! $singlet->isa('Bio::PrimarySeqI') ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
398 $self->warn("Unable to process non Bio::SeqI object [", ref($singlet), "]");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
399 return 0;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
400 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
401
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
402 my $singletID = $singlet->id();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
403 $self->warn("Replacing singlet $singletID wih a new sequence object")
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
404 if (exists $self->{'_contigs'}{$singletID});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
405 $self->{'_singlets'}{$singletID} = $singlet;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
406
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
407 return 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
408 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
409
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
410 =head2 update_seq_list
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
411
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
412 Title : update_seq_list
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
413 Usage : $assembly->update_seq_list()
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
414 Function:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
415
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
416 Synchronizes the assembly registry for sequences in
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
417 contigs and contig actual aligned sequences content. You
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
418 probably want to run this after you remove/add a
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
419 sequence from/to a contig in the assembly.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
420
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
421 Returns : nothing
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
422 Args : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
423
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
424 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
425
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
426 sub update_seq_list {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
427 my $self = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
428
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
429 $self->{'_seqs'} = {};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
430 foreach my $contig ($self->all_contigs) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
431 foreach my $seqID ($contig->get_seq_ids) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
432 $self->{'_seqs'}{$seqID} = $contig;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
433 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
434 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
435
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
436 return 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
437 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
438
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
439 =head2 remove_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
440
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
441 Title : remove_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
442 Usage : $assembly->remove_contigs(1..4)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
443 Function: Remove contig from assembly object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
444 Returns : an array of removed Bio::Assembly::Contig
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
445 objects
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
446 Args : an array of contig IDs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
447
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
448 See function get_contig_ids() above
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
449
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
450 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
451
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
452 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
453 sub remove_contigs {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
454 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
455 my ($self,@args) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
456
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
457 my @ret = ();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
458 foreach my $contigID (@args) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
459 foreach my $seqID ($self->get_contig_by_id($contigID)->get_seq_ids()) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
460 delete $self->{'_seqs'}{$seqID};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
461 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
462 push(@ret,$self->{'_contigs'}{$contigID});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
463 delete $self->{'_contigs'}{$contigID};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
464 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
465
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
466 return @ret;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
467 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
468
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
469 =head2 remove_singlets
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
470
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
471 Title : remove_singlets
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
472 Usage : $assembly->remove_singlets(@singlet_ids)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
473 Function: Remove singlet from assembly object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
474 Returns : the Bio::SeqI objects removed
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
475 Args : a list of singlet IDs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
476
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
477 See function get_singlet_ids() above
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
478
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
479 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
480
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
481 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
482 sub remove_singlets {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
483 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
484 my ($self,@args) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
485
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
486 my @ret = ();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
487 foreach my $singletID (@args) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
488 push(@ret,$self->{'_singlets'}{$singletID});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
489 delete $self->{'_singlets'}{$singletID};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
490 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
491
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
492 return @ret;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
493 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
494
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
495 =head1 Contig and singlet selection methos
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
496
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
497 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
498
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
499 =head2 select_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
500
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
501 Title : select_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
502 Usage : $assembly->select_contigs(@list)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
503 Function: Select an array of contigs from the assembly
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
504 Returns : an array of Bio::Assembly::Contig objects
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
505 Args : an array of contig ids
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
506
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
507 See function get_contig_ids() above
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
508
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
509 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
510
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
511 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
512 sub select_contigs {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
513 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
514 my ($self,@args) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
515
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
516 my @contigs = ();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
517 foreach my $contig (@args) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
518 unless (exists $self->{'_contigs'}{$contig}) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
519 $self->warn("$contig contig not found. Ignoring...");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
520 next;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
521 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
522 push(@contigs, $self->{'_contigs'}{$contig});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
523 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
524
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
525 return @contigs;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
526 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
527
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
528 =head2 select_singlets
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
529
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
530 Title : select_singlets
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
531 Usage : $assembly->select_singlets(@list)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
532 Function: Selects an array of singlets from the assembly
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
533 Returns : an array of Bio::SeqI objects
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
534 Args : an array of singlet ids
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
535
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
536 See function get_singlet_ids() above
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
537
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
538 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
539
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
540 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
541 sub select_singlets {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
542 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
543 my ($self,@args) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
544
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
545 my @singlets = ();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
546 foreach my $singlet (@args) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
547 unless (exists $self->{'_singlets'}{$singlet}) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
548 $self->warn("$singlet singlet not found. Ignoring...");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
549 next;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
550 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
551 push(@singlets, $self->{'_singlets'}{$singlet});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
552 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
553
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
554 return @singlets;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
555 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
556
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
557 =head2 all_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
558
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
559 Title : all_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
560 Usage : my @contigs = $assembly->all_contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
561 Function:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
562
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
563 Returns a list of all contigs in this assembly. Contigs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
564 are both clusters and alignments of one or more reads,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
565 with an associated consensus sequence.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
566
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
567 Returns : array of Bio::Assembly::Contig (in lexical id order)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
568 Args : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
569
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
570 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
571
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
572 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
573 sub all_contigs {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
574 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
575 my ($self) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
576
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
577 my @contigs = ();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
578 foreach my $contig (sort { $a cmp $b } keys %{ $self->{'_contigs'} }) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
579 push(@contigs, $self->{'_contigs'}{$contig});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
580 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
581
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
582 return @contigs;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
583 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
584
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
585 =head2 all_singlets
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
586
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
587 Title : all_singlets
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
588 Usage : my @singlets = $assembly->all_singlets
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
589 Function:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
590
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
591 Returns a list of all singlets in this assembly.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
592 Singlets are isolated reads, without non-vector
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
593 matches to any other read in the assembly.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
594
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
595 Returns : array of Bio::SeqI (in lexical order by id)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
596 Args : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
597
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
598 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
599
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
600 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
601 sub all_singlets {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
602 #---------------------
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
603 my ($self) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
604
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
605 my @singlets = ();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
606 foreach my $singlet (sort { $a cmp $b } keys %{ $self->{'_singlets'} }) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
607 push(@singlets, $self->{'_singlets'}{$singlet});
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
608 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
609
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
610 return @singlets;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
611 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
612
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
613 # =head1 Internal Methods
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
614
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
615 1;