Mercurial > repos > mahtabm > ensembl
comparison variant_effect_predictor/Bio/Factory/BlastResultFactory.pm @ 0:1f6dce3d34e0
Uploaded
author | mahtabm |
---|---|
date | Thu, 11 Apr 2013 02:01:53 -0400 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:1f6dce3d34e0 |
---|---|
1 #----------------------------------------------------------------- | |
2 # $Id: BlastResultFactory.pm,v 1.5 2002/10/22 07:38:32 lapp Exp $ | |
3 # | |
4 # BioPerl module for Bio::Factory::BlastResultFactory | |
5 # | |
6 # Cared for by Steve Chervitz <sac@bioperl.org> | |
7 # | |
8 # You may distribute this module under the same terms as perl itself | |
9 #----------------------------------------------------------------- | |
10 | |
11 # POD documentation - main docs before the code | |
12 | |
13 =head1 NAME | |
14 | |
15 Bio::Factory::BlastResultFactory - Factory for Bio::Search::Result::BlastResult objects | |
16 | |
17 =head1 SYNOPSIS | |
18 | |
19 use Bio::Factory::BlastResultFactory; | |
20 | |
21 my $result_fact = Bio::Factory::BlastResultFactory->new(); | |
22 | |
23 my $result = $result_fact->create_result( %parameters ); | |
24 | |
25 See documentation for create_result() for information about C<%parameters>. | |
26 | |
27 =head1 DESCRIPTION | |
28 | |
29 This module encapsulates code for creating Bio::Search::Result::BlastResult | |
30 and Bio::Search::HSP::BlastHSP objects from traditional BLAST report | |
31 data (i.e., non-XML formatted). | |
32 | |
33 =head1 FEEDBACK | |
34 | |
35 =head2 Mailing Lists | |
36 | |
37 User feedback is an integral part of the evolution of this | |
38 and other Bioperl modules. Send your comments and suggestions preferably | |
39 to one of the Bioperl mailing lists. | |
40 Your participation is much appreciated. | |
41 | |
42 bioperl-l@bioperl.org - General discussion | |
43 http://bio.perl.org/MailList.html - About the mailing lists | |
44 | |
45 =head2 Reporting Bugs | |
46 | |
47 Report bugs to the Bioperl bug tracking system to help us keep track | |
48 the bugs and their resolution. Bug reports can be submitted via email | |
49 or the web: | |
50 | |
51 bioperl-bugs@bio.perl.org | |
52 http://bugzilla.bioperl.org/ | |
53 | |
54 =head1 AUTHOR | |
55 | |
56 Steve Chervitz E<lt>sac@bioperl.orgE<gt> | |
57 | |
58 See L<the FEEDBACK section | FEEDBACK> for where to send bug reports and comments. | |
59 | |
60 =head1 COPYRIGHT | |
61 | |
62 Copyright (c) 2001 Steve Chervitz. All Rights Reserved. | |
63 | |
64 =head1 DISCLAIMER | |
65 | |
66 This software is provided "as is" without warranty of any kind. | |
67 | |
68 =head1 APPENDIX | |
69 | |
70 The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ | |
71 | |
72 =cut | |
73 | |
74 #' | |
75 | |
76 package Bio::Factory::BlastResultFactory; | |
77 | |
78 use strict; | |
79 use Bio::Root::Root; | |
80 use Bio::Factory::ResultFactoryI; | |
81 use Bio::Search::Result::BlastResult; | |
82 | |
83 use vars qw(@ISA); | |
84 | |
85 @ISA = qw(Bio::Root::Root Bio::Factory::ResultFactoryI); | |
86 | |
87 sub new { | |
88 my ($class, @args) = @_; | |
89 my $self = $class->SUPER::new(@args); | |
90 return $self; | |
91 } | |
92 | |
93 =head2 create_result | |
94 | |
95 Title : create_result | |
96 Usage : $result = $factory->create_result( %params ); | |
97 Function: Creates a new Bio::Search::Result::BlastResult object. | |
98 Returns : A single Bio::Search::Result::BlastResult object | |
99 Args : none | |
100 | |
101 =cut | |
102 | |
103 sub create_result { | |
104 my ($self, @args) = @_; | |
105 | |
106 my $result = Bio::Search::Result::BlastResult->new( @args ); | |
107 | |
108 return $result; | |
109 } | |
110 | |
111 | |
112 | |
113 1; |