.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "RG::Reprof 3pm" .TH RG::Reprof 3pm "2012-01-13" "perl v5.14.2" "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" RG::Reprof::Reprof \- protein secondary structure and accessibility predictor .SH "SYNOPSIS" .IX Header "SYNOPSIS" use RG::Reprof::Reprof; .SH "DESCRIPTION" .IX Header "DESCRIPTION" See module commented source for further details. .SS "Methods" .IX Subsection "Methods" .IP "\fI\s-1OBJ\s0\fR RG::Reprof::Reprof\->new( model_dir => \fI\s-1PATH\s0\fR )" 4 .IX Item "OBJ RG::Reprof::Reprof->new( model_dir => PATH )" Default model_dir: \fI/tmp/lkajan/root/share/reprof\fR. .Sp Returns new instance of RG::Reprof::Reprof. .ie n .IP "\fIint\fR $OBJ\->run( \fBinput_file\fR => \fI\s-1PATH\s0\fR, \fBout_file\fR => \fI\s-1PATH\s0\fR, \fBmutation_file\fR => \fI\s-1PATH\s0\fR, \fBspecific_models\fR => \fIhashref\fR, \fBoutput_func\fR => \fIcoderef\fR )" 4 .el .IP "\fIint\fR \f(CW$OBJ\fR\->run( \fBinput_file\fR => \fI\s-1PATH\s0\fR, \fBout_file\fR => \fI\s-1PATH\s0\fR, \fBmutation_file\fR => \fI\s-1PATH\s0\fR, \fBspecific_models\fR => \fIhashref\fR, \fBoutput_func\fR => \fIcoderef\fR )" 4 .IX Item "int $OBJ->run( input_file => PATH, out_file => PATH, mutation_file => PATH, specific_models => hashref, output_func => coderef )" .RS 4 .PD 0 .IP "\fBout_file\fR may be a directory." 4 .IX Item "out_file may be a directory." .IP "\fBmutation_file\fR may be undefined." 4 .IX Item "mutation_file may be undefined." .IP "\fBspecific_models\fR may be undefined." 4 .IX Item "specific_models may be undefined." .PD This is a hash of model and feature files with 'model_name' keys like: .Sp .Vb 4 \& { \& \*(Aqfub_model\*(Aq => \*(Aq/path/to/model_file\*(Aq, \& \*(Aqfub_features\*(Aq => \*(Aq/path/to/features_file\*(Aq \& } .Ve .Sp Check the module source for the list for model names. .IP "\fIvoid\fR \fBoutput_func\fR( out_file, sec_pred, acc_pred, sequence ) \- function to call when output is ready." 4 .IX Item "void output_func( out_file, sec_pred, acc_pred, sequence ) - function to call when output is ready." If undefined, the built-in \fIwrite_output()\fR function is called that prints results to one or more files. The following positional parameters are passed to this function: .RS 4 .IP "out_file" 4 .IX Item "out_file" Output file name. .IP "sec_pred" 4 .IX Item "sec_pred" Secondary structure prediction, see source for details. .IP "acc_pred" 4 .IX Item "acc_pred" Accessibility prediction, see source for details. .IP "sequence" 4 .IX Item "sequence" Reference to array of residues of input sequence (e.g. [ 'M', 'A', 'G', ... ] ). .RE .RS 4 .RE .RE .RS 4 .RE .SH "AUTHOR" .IX Header "AUTHOR" Original version by Peter Hoenigschmid and Burkhard Rost. .PP Some perl module work and documentation by Laszlo Kajan . .SH "SEE ALSO" .IX Header "SEE ALSO"