Rkitsch: R interface for kitsch

Description

This function is an R interface for kitsch in the PHYLIP package (Felsenstein 2013). kitsch can be used for tree inference using the Fitch-Margoliash method (Fitch & Margoliash 1967), the Cavalli-Sforza & Edwards leasts-squares method (Cavalli-Sforza & Edwards 1967), and the minimum evolution criterion (Kidd & Sgaramella-Zonta 1971; Nei & Rzhetsky 1993), but contraining the branch lengths of the tree to be clock-like (i.e., all paths from the root to any tip are equal in length).

Usage

Rkitsch(D, path=NULL , ...)

Arguments

a distance matrix as an object of class "matrix", "data.frame", or "dist". If a matrix, then D should be symmetrical with a diagonal of zeros.

path

path to the executable containing kitsch. If path = NULL, the R will search several commonly used directories for the correct executable file.

...

optional arguments to be passed to kitsch. See details for more information.

Value

This function returns an object of class "phylo" that is the NJ or UPGMA tree.

Details

Optional arguments include the following: quiet suppress some output to R console (defaults to quiet = FALSE); method - can be "FM" or "fm" (for the Fitch-Margoliash criterion; Fitch & Margoliash 1967), "LS" or "ls" for the Cavalli-Sforza & Edwards (1967) least-squares criterion, or "ME" or "me" (for Minimum Evolution); tree object of class "phylo" - if supplied, then branch lengths are optimized & the optimality criterion is computed on the input tree; negative a logical value indicating whether negative branch lengths should be permitted (defaults to negative = TRUE; random.order add taxa to tree in random order (defaults to random.order = TRUE); random.addition number of random addition replicates for random.order = TRUE (defaults to random.addition = 10); outgroup outgroup if outgroup rooting of the estimated tree is desired; subreplicate, a logical value indicating whether or not to perform the subreplication test of Felsenstein (1986); and cleanup remove PHYLIP input & output files after the analysis is completed (defaults to cleanup = TRUE). Note that for some reason subreplicate=TRUE does not appear to work in the current version of kitsch.

More information about the kitsch program in PHYLIP can be found here http://evolution.genetics.washington.edu/phylip/doc/kitsch.html.

Obviously, use of any of the functions of this package requires that PHYLIP (Felsenstein 1989, 2013) should first be installed. More information about installing PHYLIP can be found on the PHYLIP webpage: http://evolution.genetics.washington.edu/phylip.html.

References

Cavalli-Sforza, L.L., Edwards, A.W.F. (1967) Phylogenetic analysis: models and estimation procedures. Evolution, 32, 550-570.

Felsenstein, J. (1986) Distance methods: a reply to Farris. Cladistics, 2, 130-144.

Fitch, W.M., Margoliash, E. (1967) Construction of phylogenetic trees. Science, 155, 279-284.

Kidd, K.K., Sgaramella-Zonta, L.A. (1971) Phylogenetic analysis: concepts and methods. American Journal of Human Genetics, 23, 235-252.

Felsenstein, J. (1989) PHYLIP--Phylogeny Inference Package (Version 3.2). Cladistics, 5, 164-166.

Felsenstein, J. (2013) PHYLIP (Phylogeny Inference Package) version 3.695. Distributed by the author. Department of Genome Sciences, University of Washington, Seattle.

Examples

Run this code

## Not run: 
# data(primates)
# D<-dist.dna(data(primates),model="JC")
# tree<-Rkitsch(D)
# ## End(Not run)

Run the code above in your browser using DataLab