blib/lib/Bio/Graphics/RendererI.pm untested

filter: Statementstmt 0.0% 0 / 7 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 3 Podpod 0.0% 0 / 1 totaltotal 0.0% 0 / 11 CC 1 SCAR 6.9
CC
1
Cov
0%
render
2.0
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1 =head1 NAME
2  
3 Bio::Graphics::RendererI - A renderer for the Bio::Graphics class that
4 renders Bio::SeqFeature::CollectionI objects onto
5 Bio::Graphics::Panels using configuration information provided by a
6 Bio::Graphics::ConfiguratorI.
7  
8 =head1 SYNOPSIS
9  
10 # Get a renderer somehow, called $renderer
11  
12 # create a new panel and render contents a feature collection onto it
13 my $config = new ConfigIO( $config_file )->getConfig();
14 my $features = $data_provider->getCollection();
15 my ( $tracks_rendered, $panel ) = $renderer->render( $features, $prefs );
16  
17 =head1 DESCRIPTION
18  
19 Renderer of Bio::SeqFeature::CollectionIs (collections of features)
20 onto a Bio::Graphics::Panel using a Bio::Graphics::ConfiguratorI for
21 general and track-specific rendering options.
22  
23 =head1 FEEDBACK
24  
25 =head2 Mailing Lists
26  
27 User feedback is an integral part of the evolution of this and other
28 Bioperl modules. Send your comments and suggestions preferably to
29 the Bioperl mailing list. Your participation is much appreciated.
30  
31 bioperl-l@bioperl.org - General discussion
32 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
33  
34 =head2 Reporting Bugs
35  
36 Report bugs to the Bioperl bug tracking system to help us keep track
37 of the bugs and their resolution. Bug reports can be submitted via the
38 web:
39  
40 http://bugzilla.open-bio.org/
41  
42 =head1 AUTHOR
43  
44 Paul Edlefsen E<lt>paul@systemsbiology.orgE<gt>.
45  
46 Copyright (c) 2003 Institute for Systems Biology
47  
48 This library is free software; you can redistribute it and/or modify
49 it under the same terms as Perl itself. See DISCLAIMER.txt for
50 disclaimers of warranty.
51  
52 =head1 APPENDIX
53  
54 The rest of the documentation details each of the object methods.
55 Internal methods are usually preceded with a _
56  
57 =cut
58  
59 # Let the code begin...
60  
61 package Bio::Graphics::RendererI;
62 use strict;
63  
64 use base qw(Bio::Root::RootI);
65  
66 =head2 render
67  
68 Title : render
69 Usage : ( $rendered, $panel ) =
70 $renderer->render( $collection, $configurator [, $panel ] );
71 Function: Renders the SeqFeatures in the given collection onto a
72 Bio::Graphics::Panel (if no panel is given, one will be
73 created), using the given Bio::Graphics::ConfiguratorI for general
74 and track-specific rendering options.
75 Returns : In a scalar context returns the number of tracks rendered.
76 In a list context, returns a two-element list containing
77 the number of features rendered and the panel.
78 Args : A Bio::SeqFeature::CollectionI and a Bio::Graphics::ConfiguratorI
79 and optionally a Bio::Graphics::Panel.
80 Status : Public
81  
82 =cut
83  
84 sub render {
85 shift->throw_not_implemented();
86 }
87  
88 1;