.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 "TFBS::PatternGen::Elph 3pm"
.TH TFBS::PatternGen::Elph 3pm "2018-11-02" "perl v5.28.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"
TFBS::PatternGen::Elph \- a pattern factory that uses the Elph program
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&    my $patterngen =
\&            TFBS::PatternGen::Elph\->new(\-seq_file=>\*(Aqsequences.fa\*(Aq,
\&                                         \-binary => \*(Aq/Elph/elph\*(Aq
\&                                         \-motif_length => [8, 9, 10],
\&                                         \-additional_params => \*(Aq\-x \-r \-e\*(Aq);
\&
\&    my $pfm = $patterngen\->pattern(); # $pfm is now a TFBS::Matrix::PFM object
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
TFBS::PatternGen::Gibbs builds position frequency matrices
using an advanced Gibbs sampling algorithm implemented in external
\&\fIGibbs\fR program by Chip Lawrence. The algorithm can produce
multiple patterns from a single set of sequences.
.SS "new"
.IX Subsection "new"
.Vb 10
\& Title   : new
\& Usage   : my $db = TFBS::PatternGen::Gibbs\->new(%args);
\& Function: the constructor for the TFBS::PatternGen::Gibbs object
\& Returns : a TFBS::PatternGen::Gibbs object
\& Args    : This method takes named arguments;
\&            you must specify one of the following three
\&            \-seq_list     # a reference to an array of strings
\&                          #   and/or Bio::Seq objects
\&              # or
\&            \-seq_stream   # A Bio::SeqIO object
\&              # or
\&            \-seq_file     # the name of the fasta file containing
\&                          #   all the sequences
\&           Other arguments are:
\&            \-binary       # a fully qualified path to Gibbs executable
\&                          #  OPTIONAL: default \*(AqGibbs\*(Aq
\&            \-nr_hits      # a presumed number of pattern occurrences in the
\&                          #   sequence set: it can be a single integer, e.g.
\&                          #   \-nr_hits => 24 , or a reference to an array of
\&                          #   integers, e.g \-nr_hits => [12, 24, 36]
\&            \-motif_length # an expected length of motif in nucleotides:
\&                          #   it can be a single integer, e.g.
\&                          #   \-motif_length => 8 , or a reference to an
\&                          #   array ofintegers, e.g \-motif_length => [8..12]
\&            \-additional_params  # a string containing additional
\&                                #   command\-line switches for the
\&                                #   Gibbs program
.Ve
.SS "pattern"
.IX Subsection "pattern"
.SS "all_patterns"
.IX Subsection "all_patterns"
.SS "patternSet"
.IX Subsection "patternSet"
The three methods listed above are used for the retrieval of patterns,
and are common to all TFBS::PatternGen::* classes. Please
see TFBS::PatternGen for details.