econsense

 

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

Majority-rule and strict consensus tree

Description

ECONSENSE -- Embossified consensus tree program

Phylip consense documentation.

Usage

Here is a sample session with econsense


% econsense 
Majority-rule and strict consensus tree
Phylip tree file: consense.dat
Phylip consense program output file [econsense.outfile]: 
Create a tree file [Y]: 
Phylip tree output file [consense.treefile]: 



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

Command line arguments

Majority-rule and strict consensus tree
Version: EMBOSS:6.6.0.0

   Standard (Mandatory) qualifiers (* if not always prompted):
  [-infile]            infile     Phylip tree file
*  -og                 toggle     [N] Outgroup root
*  -outgnum            integer    [1] Number of the outgroup (Integer 1 or
                                  more)
  [-outfile]           outfile    [econsense.outfile] Phylip consense program
                                  output file
   -[no]trout          boolean    [Y] Create a tree file
  [-treefile]          outfile    [*.econsense] Phylip tree output file

   Additional (Optional) qualifiers:
   -root               toggle     [N] Trees to be treated as rooted
   -[no]drawtree       boolean    [Y] Draw tree
   -progress           boolean    [N] Print indications of progress of run
   -[no]printsets      boolean    [Y] Print out the sets of species

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

   "-outfile" associated qualifiers
   -odirectory2        string     Output directory

   "-treefile" associated qualifiers
   -odirectory3        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 tree file Input file Required
-og toggle Outgroup root Toggle value Yes/No No
-outgnum integer Number of the outgroup Integer 1 or more 1
[-outfile]
(Parameter 2)
outfile Phylip consense program output file Output file econsense.outfile
-[no]trout boolean Create a tree file Boolean value Yes/No Yes
[-treefile]
(Parameter 3)
outfile Phylip tree output file Output file <*>.econsense
Additional (Optional) qualifiers
-root toggle Trees to be treated as rooted Toggle value Yes/No No
-[no]drawtree boolean Draw tree Boolean value Yes/No Yes
-progress boolean Print indications of progress of run Boolean value Yes/No No
-[no]printsets boolean Print out the sets of species 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
-odirectory3
-odirectory_treefile
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: consense.dat

(A,(B,(H,(D,(J,(((G,E),(F,I)),C))))));
(A,(B,(D,((J,H),(((G,E),(F,I)),C)))));
(A,(B,(D,(H,(J,(((G,E),(F,I)),C))))));
(A,(B,(E,(G,((F,I),((J,(H,D)),C))))));
(A,(B,(E,(G,((F,I),(((J,H),D),C))))));
(A,(B,(E,((F,I),(G,((J,(H,D)),C))))));
(A,(B,(E,((F,I),(G,(((J,H),D),C))))));
(A,(B,(E,((G,(F,I)),((J,(H,D)),C)))));
(A,(B,(E,((G,(F,I)),(((J,H),D),C)))));

Output file format

Output files for usage example

File: econsense.outfile


Majority-rule and strict consensus tree program, version 3.57c.650

Species in order: 

  A
  B
  H
  D
  J
  G
  E
  F
  I
  C


Sets included in the consensus tree

Set (species in order)     How many times out of   9.00

.......**.                   9.00
..********                   9.00
..***....*                   6.00
..****.***                   6.00
..***.....                   6.00
..*.*.....                   4.00
..***..***                   2.00


Sets NOT included in consensus tree:

Set (species in order)     How many times out of   9.00

.....**...                   3.00
.....****.                   3.00
..**......                   3.00
.....*****                   3.00
..*.******                   2.00
.....*.**.                   2.00
..****...*                   2.00
....******                   2.00
...*******                   1.00


CONSENSUS TREE:
the numbers at the forks indicate the number
of times the group consisting of the species
which are to the right of that fork occurred
among the trees, out of   9.00 trees

  +---------------------------------------A                   
  !
  !         +-----------------------------E                   
  !         !
  !         !                        +----I                   
  !         !         +------------9.0
  !         !         !              +----F                   
  !    +--9.0         !
  !    !    !    +--2.0         +---------D                   
  !    !    !    !    !    +--6.0
  !    !    !    !    !    !    !    +----J                   
  !    !    !    !    +--6.0    +--4.0
  +--9.0    +--6.0         !         +----H                   
       !         !         !
       !         !         +--------------C                   
       !         !
       !         +------------------------G                   
       !
       +----------------------------------B                   


  remember: this is an unrooted tree!

File: consense.treefile

(A:9.0,((E:9.0,(((I:9.0,F:9.0):9.0,((D:9.0,(J:9.0,H:9.0):4.0):6.0,C:9.0):6.0):2.0,G:9.0):6.0):9.0,
B:9.0):9.0);

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

See also

Program name Description
fconsense Majority-rule and strict consensus tree
ftreedist Calculate distances between trees
ftreedistpair Calculate distance between two sets of trees

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