epenny

 

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, branch-and-bound

Description

EPENNY - Embossified branch and bound to find all most parsimonious trees

Phylip penny documentation.

Usage

Here is a sample session with epenny


% epenny 
Penny algorithm, branch-and-bound
Phylip penny program input file: penny.dat
Method
       Wag : Wagner
       Cam : Camin-Sokal
       Mix : Mixed
Choose the method to use [Wag]: 
Phylip penny program output file [epenny.outfile]: 
Create a tree file [Y]: 
Phylip tree output file [epenny.treefile]: 



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

Command line arguments

Penny algorithm, branch-and-bound
Version: EMBOSS:6.6.0.0

   Standard (Mandatory) qualifiers (* if not always prompted):
  [-infile]            infile     Phylip penny program input file
*  -datasets           integer    [0] How many data sets (Any integer value)
   -method             menu       [Wag] Choose the method to use (Values: Wag
                                  (Wagner); Cam (Camin-Sokal); Mix (Mixed))
*  -outgnum            integer    [1] Number of the outgroup (Integer 1 or
                                  more)
*  -valthresh          float      [1.0] Threshold value (Number 1.000 or more)
  [-outfile]           outfile    [epenny.outfile] Phylip penny program output
                                  file
  [-[no]trout]         toggle     [Y] Create a tree file
*  -treefile           outfile    [epenny.treefile] Phylip tree output file

   Additional (Optional) qualifiers:
   -multsets           toggle     [N] Analyze multiple data sets
   -og                 toggle     [N] Outgroup root
   -numgroups          integer    [1000] How many groups of 100 trees (Any
                                  integer value)
   -howoften           integer    [100] How often to report, in trees (Any
                                  integer value)
   -simple             boolean    Branch and bound is simple
   -printdata          boolean    [N] Print out the data at start of run
   -progress           boolean    [N] Print indications of progress of run
   -steps              boolean    [N] Print out steps in each site
   -seqatnodes         boolean    [N] Print sequences at all nodes of tree
   -[no]drawtree       boolean    [Y] Draw tree

   Advanced (Unprompted) qualifiers:
   -thresh             toggle     [N] Use Threshold parsimony

   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 penny program input file Input file Required
-datasets integer How many data sets Any integer value 0
-method list Choose the method to use
Wag (Wagner)
Cam (Camin-Sokal)
Mix (Mixed)
Wag
-outgnum integer Number of the outgroup Integer 1 or more 1
-valthresh float Threshold value Number 1.000 or more 1.0
[-outfile]
(Parameter 2)
outfile Phylip penny program output file Output file epenny.outfile
[-[no]trout]
(Parameter 3)
toggle Create a tree file Toggle value Yes/No Yes
-treefile outfile Phylip tree output file Output file epenny.treefile
Additional (Optional) qualifiers
-multsets toggle Analyze multiple data sets Toggle value Yes/No No
-og toggle Outgroup root Toggle value Yes/No No
-numgroups integer How many groups of 100 trees Any integer value 1000
-howoften integer How often to report, in trees Any integer value 100
-simple boolean Branch and bound is simple Boolean 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
-steps boolean Print out steps in each site Boolean value Yes/No No
-seqatnodes boolean Print sequences at all nodes of tree Boolean value Yes/No No
-[no]drawtree boolean Draw tree Boolean value Yes/No Yes
Advanced (Unprompted) qualifiers
-thresh toggle Use Threshold parsimony Toggle value Yes/No No
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: penny.dat

    7    6
Alpha1    110110
Alpha2    110110
Beta1     110000
Beta2     110000
Gamma1    100110
Delta     001001
Epsilon   001110

Output file format

Output files for usage example

File: epenny.outfile

Wagner parsimony method

                     


requires a total of              8.000

    3 trees in all found




  +-----------------Alpha1    
  !  
  !        +--------Alpha2    
--1        !  
  !  +-----4     +--Epsilon   
  !  !     !  +--6  
  !  !     +--5  +--Delta     
  +--2        !  
     !        +-----Gamma1    
     !  
     !           +--Beta2     
     +-----------3  
                 +--Beta1     

  remember: this is an unrooted tree!




  +-----------------Alpha1    
  !  
--1  +--------------Alpha2    
  !  !  
  !  !           +--Epsilon   
  +--2        +--6  
     !  +-----5  +--Delta     
     !  !     !  
     +--4     +-----Gamma1    
        !  
        !        +--Beta2     
        +--------3  
                 +--Beta1     

  remember: this is an unrooted tree!




  +-----------------Alpha1    
  !  
  !           +-----Alpha2    
--1  +--------2  
  !  !        !  +--Beta2     
  !  !        +--3  
  +--4           +--Beta1     
     !  
     !           +--Epsilon   
     !        +--6  
     +--------5  +--Delta     
              !  
              +-----Gamma1    

  remember: this is an unrooted tree!

File: epenny.treefile

(Alpha1,((Alpha2,((Epsilon,Delta),Gamma1)),(Beta2,Beta1)))[0.3333];
(Alpha1,(Alpha2,(((Epsilon,Delta),Gamma1),(Beta2,Beta1))))[0.3333];
(Alpha1,((Alpha2,(Beta2,Beta1)),((Epsilon,Delta),Gamma1)))[0.3333];

Data files

None.

Notes

None.

References

None.

Warnings

None.

Diagnostics

None.

Exit status

It always exits with status 0.

Known bugs

None.

See also

Program name Description
eclique Largest clique program
edollop Dollo and polymorphism parsimony algorithm
edolpenny Penny algorithm Dollo or polymorphism
efactor Multistate to binary recoding program
emix Mixed parsimony algorithm
fclique Largest clique program
fdollop Dollo and polymorphism parsimony algorithm
fdolpenny Penny algorithm Dollo or polymorphism
ffactor Multistate to binary recoding program
fmix Mixed parsimony algorithm
fmove Interactive mixed method parsimony
fpars Discrete character parsimony
fpenny Penny algorithm, branch-and-bound

Author(s)

(c) Copyright 1986-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