.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Bio::Cluster::ClusterFactory 3pm"
.TH Bio::Cluster::ClusterFactory 3pm "2022-03-27" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Bio::Cluster::ClusterFactory \- Instantiates a new Bio::ClusterI (or derived class) through a factory
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    use Bio::Cluster::ClusterFactory;
\&    # if you don\*(Aqt provide a default type, the factory will try
\&    # some guesswork based on display_id and namespace
\&    my $factory = Bio::Cluster::ClusterFactory\->new(\-type => \*(AqBio::Cluster::UniGene\*(Aq);
\&    my $clu = $factory\->create_object(\-description => \*(AqNAT\*(Aq,
\&                                      \-display_id  => \*(AqHs.2\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This object will build Bio::ClusterI objects generically.
.SH "FEEDBACK"
.IX Header "FEEDBACK"
.SS "Mailing Lists"
.IX Subsection "Mailing Lists"
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list.  Your participation is much appreciated.
.PP
.Vb 2
\&  bioperl\-l@bioperl.org                  \- General discussion
\&  http://bioperl.org/wiki/Mailing_lists  \- About the mailing lists
.Ve
.SS "Support"
.IX Subsection "Support"
Please direct usage questions or support issues to the mailing list:
.PP
\&\fIbioperl\-l@bioperl.org\fR
.PP
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
.SS "Reporting Bugs"
.IX Subsection "Reporting Bugs"
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via the
web:
.PP
.Vb 1
\&  https://github.com/bioperl/bioperl\-live/issues
.Ve
.SH "AUTHOR \- Hilmar Lapp"
.IX Header "AUTHOR - Hilmar Lapp"
Email hlapp at gmx.net
.SH "APPENDIX"
.IX Header "APPENDIX"
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
.SS "new"
.IX Subsection "new"
.Vb 8
\& Title   : new
\& Usage   : my $obj = Bio::Cluster::ClusterFactory\->new();
\& Function: Builds a new Bio::Cluster::ClusterFactory object
\& Returns : Bio::Cluster::ClusterFactory
\& Args    : \-type => string, name of a ClusterI derived class.
\&                    If not provided, the factory will have to guess
\&                    from ID and namespace, which may or may not be
\&                    successful.
.Ve
.SS "create_object"
.IX Subsection "create_object"
.Vb 3
\& Title   : create_object
\& Usage   : my $seq = $factory\->create_object(<named parameters>);
\& Function: Instantiates new Bio::ClusterI (or one of its child classes)
\&
\&           This object allows us to genericize the instantiation of
\&           cluster objects.
\&
\& Returns : L<Bio::ClusterI> compliant object
\&           The return type is configurable using new(\-type =>"...").
\& Args    : initialization parameters specific to the type of cluster
\&           object we want.  Typically
\&           \-display_id  => $name
\&           \-description => description of the cluster
\&           \-members     => arrayref, members of the cluster
.Ve
.SS "_guess_type"
.IX Subsection "_guess_type"
.Vb 9
\& Title   : _guess_type
\& Usage   :
\& Function: Guesses the right type of L<Bio::ClusterI> implementation
\&           based on initialization parameters for the prospective
\&           object.
\& Example :
\& Returns : the type (a string, the module name)
\& Args    : initialization parameters to be passed to the prospective
\&           cluster object
.Ve