eneighbor

 

Wiki

The master copies of EMBOSS documentation are available at http://emboss.open-bio.org/wiki/Appdocs on the EMBOSS Wiki.

Please help by correcting and extending the Wiki pages.

Function

Penny algorithm for DNA

Description

ENEIGHBOR -- Embossified Neighbor-Joining and UPGMA methods

Phylip neighbor documentation.

Usage

Here is a sample session with eneighbor


% eneighbor 
Phylogenies from distance matrix by N-J or UPGMA method
Phylip neighbor program input file: neighbor.dat
Neighbor-joining [Y]: 
Outgroup root [N]: 
Phylip neighbor program output file [eneighbor.outfile]: 
Create a tree file [Y]: 
Phylip tree output file [eneighbor.treefile]: 

Go to the input files for this example
Go to the output files for this example

Command line arguments

Phylogenies from distance matrix by N-J or UPGMA method
Version: EMBOSS:6.5.0.0

   Standard (Mandatory) qualifiers (* if not always prompted):
  [-infile]            infile     Phylip neighbor program input file
*  -datasets           integer    [0] How many data sets (Any integer value)
   -[no]nj             toggle     [Y] Neighbor-joining
*  -og                 toggle     [N] Outgroup root
*  -outgnum            integer    [0] Number of the outgroup (Any integer
                                  value)
*  -randseed           integer    [0] Random number seed (must be odd) (Any
                                  integer value)
  [-outfile]           outfile    [eneighbor.outfile] Phylip neighbor program
                                  output file
  [-[no]trout]         toggle     [Y] Create a tree file
*  -treefile           outfile    [eneighbor.treefile] Phylip tree output file

   Additional (Optional) qualifiers:
   -lt                 boolean    [N] Lower-triangular data matrix
   -ut                 boolean    [N] Upper-triangular data matrix
   -[no]sr             boolean    [Y] Subreplicates
   -multsets           toggle     [N] Analyze multiple data sets
   -random             toggle     [N] Randomize input order of species
   -printdata          boolean    [N] Print out the data at start of run
   -progress           boolean    [N] Print indications of progress of run
   -[no]drawtree       boolean    [Y] Draw tree

   Advanced (Unprompted) qualifiers: (none)
   Associated qualifiers:

   "-outfile" associated qualifiers
   -odirectory2        string     Output directory

   "-treefile" associated qualifiers
   -odirectory         string     Output directory

   General qualifiers:
   -auto               boolean    Turn off prompts
   -stdout             boolean    Write first file to standard output
   -filter             boolean    Read first file from standard input, write
                                  first file to standard output
   -options            boolean    Prompt for standard and additional values
   -debug              boolean    Write debug output to program.dbg
   -verbose            boolean    Report some/full command line options
   -help               boolean    Report command line options and exit. More
                                  information on associated and general
                                  qualifiers can be found with -help -verbose
   -warning            boolean    Report warnings
   -error              boolean    Report errors
   -fatal              boolean    Report fatal errors
   -die                boolean    Report dying program messages
   -version            boolean    Report version number and exit

Qualifier Type Description Allowed values Default
Standard (Mandatory) qualifiers
[-infile]
(Parameter 1)
infile Phylip neighbor program input file Input file Required
-datasets integer How many data sets Any integer value 0
-[no]nj toggle Neighbor-joining Toggle value Yes/No Yes
-og toggle Outgroup root Toggle value Yes/No No
-outgnum integer Number of the outgroup Any integer value 0
-randseed integer Random number seed (must be odd) Any integer value 0
[-outfile]
(Parameter 2)
outfile Phylip neighbor program output file Output file eneighbor.outfile
[-[no]trout]
(Parameter 3)
toggle Create a tree file Toggle value Yes/No Yes
-treefile outfile Phylip tree output file Output file eneighbor.treefile
Additional (Optional) qualifiers
-lt boolean Lower-triangular data matrix Boolean value Yes/No No
-ut boolean Upper-triangular data matrix Boolean value Yes/No No
-[no]sr boolean Subreplicates Boolean value Yes/No Yes
-multsets toggle Analyze multiple data sets Toggle value Yes/No No
-random toggle Randomize input order of species Toggle value Yes/No No
-printdata boolean Print out the data at start of run Boolean value Yes/No No
-progress boolean Print indications of progress of run Boolean value Yes/No No
-[no]drawtree boolean Draw tree Boolean value Yes/No Yes
Advanced (Unprompted) qualifiers
(none)
Associated qualifiers
"-outfile" associated outfile qualifiers
-odirectory2
-odirectory_outfile
string Output directory Any string  
"-treefile" associated outfile qualifiers
-odirectory string Output directory Any string  
General qualifiers
-auto boolean Turn off prompts Boolean value Yes/No N
-stdout boolean Write first file to standard output Boolean value Yes/No N
-filter boolean Read first file from standard input, write first file to standard output Boolean value Yes/No N
-options boolean Prompt for standard and additional values Boolean value Yes/No N
-debug boolean Write debug output to program.dbg Boolean value Yes/No N
-verbose boolean Report some/full command line options Boolean value Yes/No Y
-help boolean Report command line options and exit. More information on associated and general qualifiers can be found with -help -verbose Boolean value Yes/No N
-warning boolean Report warnings Boolean value Yes/No Y
-error boolean Report errors Boolean value Yes/No Y
-fatal boolean Report fatal errors Boolean value Yes/No Y
-die boolean Report dying program messages Boolean value Yes/No Y
-version boolean Report version number and exit Boolean value Yes/No N

Input file format

Input files for usage example

File: neighbor.dat

    7
Bovine      0.0000  1.6866  1.7198  1.6606  1.5243  1.6043  1.5905
Mouse       1.6866  0.0000  1.5232  1.4841  1.4465  1.4389  1.4629
Gibbon      1.7198  1.5232  0.0000  0.7115  0.5958  0.6179  0.5583
Orang       1.6606  1.4841  0.7115  0.0000  0.4631  0.5061  0.4710
Gorilla     1.5243  1.4465  0.5958  0.4631  0.0000  0.3484  0.3083
Chimp       1.6043  1.4389  0.6179  0.5061  0.3484  0.0000  0.2692
Human       1.5905  1.4629  0.5583  0.4710  0.3083  0.2692  0.0000

Output file format

Output files for usage example

File: eneighbor.outfile


   7 Populations

 Neighbor-joining method

 Negative branch lengths allowed


  +--------Orang     
  !  
  !  +----Gorilla   
--5--4  
  !  !  +----Chimp     
  !  +--3  
  !     +---Human     
  !  
  !               +---------------------------Bovine    
  !  +------------1  
  +--2            +----------------------Mouse     
     !  
     +----------Gibbon    


remember: this is an unrooted tree!

Between        And            Length
-------        ---            ------
   5          Orang             0.28469
   5             4              0.02696
   4          Gorilla           0.15393
   4             3              0.03982
   3          Chimp             0.15167
   3          Human             0.11753
   5             2              0.04648
   2             1              0.42027
   1          Bovine            0.91769
   1          Mouse             0.76891
   2          Gibbon            0.35793


File: eneighbor.treefile

(Orang:0.28469,(Gorilla:0.15393,(Chimp:0.15167,Human:0.11753):0.03982):0.02696,((Bovine:0.91769,
Mouse:0.76891):0.42027,Gibbon:0.35793):0.04648);

Data files

None.

Notes

Multiple sequences sets not implemented yet!.

References

None.

Warnings

None.

Diagnostics

None.

Exit status

It always exits with status 0.

Known bugs

None.

See also

Program name Description
efitch Fitch-Margoliash and least-squares distance methods
ekitsch Fitch-Margoliash method with contemporary tips
ffitch Fitch-Margoliash and least-squares distance methods
fkitsch Fitch-Margoliash method with contemporary tips
fneighbor Phylogenies from distance matrix by N-J or UPGMA method

Author(s)

(c) Copyright 1991-1993 by Joseph Felsenstein and by the University of Washington. Written by Joseph Felsenstein. Permission is granted to copy this document provided that no fee is charged for it and that this copyright notice is not removed.

This application was modified for inclusion in EMBOSS by Ian Longden (il@sanger.ac.uk) Informatics Division, The Sanger Centre, Wellcome Trust Genome Campus, Hinxton, Cambridge, CB10 1SA, UK.

History

Target users

This program is intended to be used by everyone and everything, from naive users to embedded scripts.

Comments

None