.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "BP_RUN_PROTDIST 1p"
.TH BP_RUN_PROTDIST 1p 2024-04-27 "perl v5.38.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
run_neighbor \- run Phylip's 'protdist' program through Bioperl
.SH SYNOPSIS
.IX Header "SYNOPSIS"
run_protdist [\-i inputfile] [\-o outfilename]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Provide an alignment file to run protdist on.  File should be named
either .aln or .phy.  This is required so that we can determine if we
need to convert a clustalw alignment into phylip.  You are welcome to
extend the script to work on other MSA formats which bioperl supports.
This is intended to be used in very simple manual pipelines.
.PP
The input file should be named in the form of file.phy or file.aln 
the program expects a file in the form of (\eS+)\e.(\eS+).
.PP
This will run the application 'protdist' using the 'KIMURA' formula to
build a a protein distance matrix.  Those with phylip3.6 will want to
make some changes if they want to use JTT.  I'm happy to help add this
in as a cmd-line argument if it is requested.
.SH AUTHOR
.IX Header "AUTHOR"
Jason Stajich, jason-AT-open-bio-DOT-org