man/clustal.Rd

   1 \name{clustal}
   2 \alias{clustal}
   3 \alias{muscle}
   4 \alias{tcoffee}
   5 \title{Multiple Sequence Alignment with External Applications}
   6 \description{
   7   These functions call their respective program from \R to align a set of
   8   nucleotide sequences of class \code{"DNAbin"}.
   9 }
  10 \usage{
  11 clustal(x, pw.gapopen = 10, pw.gapext = 0.1,
  12         gapopen = 10, gapext = 0.2, exec = NULL,
  13         MoreArgs = "", quiet = TRUE)
  14 muscle(x, exec = "muscle", MoreArgs = "", quiet = TRUE)
  15 tcoffee(x, exec = "t_coffee", MoreArgs = "", quiet = TRUE)
  16 }
  17 \arguments{
  18   \item{x}{an object of class \code{"DNAbin"}.}
  19   \item{pw.gapopen, pw.gapext}{gap opening and gap extension penalties
  20     used by Clustal during pairwise alignments.}
  21   \item{gapopen, gapext}{idem for global alignment.}
  22   \item{exec}{a character string giving the name of the program, with
  23     its path if necessary. \code{clustal} tries to guess it depending on
  24     the operating system (see details).}
  25   \item{MoreArgs}{a character string giving additional options.}
  26   \item{quiet}{a logical: the default is to not print on \R's console the
  27     messages from the external program.}
  28 }
  29 \details{
  30   \code{clustal} tries to guess the name of the executable program
  31   depending on the operating system. Specifically, the followings are
  32   used: ``clustalw'' under Linux, ``clustalw2'' under MacOS, or
  33   ``C:/Program Files/ClustalW2/clustalw2'' under Windows.
  34
  35   The calculations are done in a temporary directory which is deleted
  36   when \R is quit. So it is possible to find the files created by the
  37   last call in the directory printed by \code{tempdir()}.
  38
  39   When called without arguments (i.e., \code{clustal()}, \dots), the
  40   function prints the options of the program which may be passed to
  41   \code{MoreArgs}.
  42 }
  43 \value{
  44   an object of class \code{"DNAbin"} with the aligned sequences.
  45 }
  46 \references{
  47   Chenna, R., Sugawara, H., Koike, T., Lopez, R., Gibson, T. J.,
  48   Higgins, D. G. and Thompson, J. D. (2003) Multiple sequence alignment
  49   with the Clustal series of programs. \emph{Nucleic Acids Research}
  50   \bold{31}, 3497--3500.
  51
  52   \url{http://www.clustal.org/}
  53
  54   Edgar, R. C. (2004) MUSCLE: Multiple sequence alignment with high
  55   accuracy and high throughput. \emph{Nucleic Acids Research},
  56   \bold{32}, 1792--1797.
  57
  58   \url{http://www.drive5.com/muscle/muscle_userguide3.8.html}
  59
  60   Notredame, C., Higgins, D. and Heringa, J. (2000) T-Coffee: A novel
  61   method for multiple sequence alignments. \emph{Journal of Molecular
  62   Biology}, \bold{302}, 205--217.
  63
  64   \url{http://www.tcoffee.org/Documentation/t_coffee/t_coffee_technical.htm}
  65 }
  66 \author{Emmanuel Paradis}
  67 \seealso{
  68   \code{\link{image.DNAbin}}, \code{\link{del.gaps}}
  69
  70   The package \pkg{phyloch} which has similar functions for the MAFFT
  71   and Prank.
  72 }
  73 \examples{
  74 \dontrun{
  75 ### display the options:
  76 clustal()
  77 muscle()
  78 tcoffee()
  79
  80 data(woodmouse)
  81 ### open gaps more easily:
  82 clustal(woodmouse, pw.gapopen = 1, pw.gapext = 1)
  83 ### T-Coffee requires negative values (quite slow; muscle is much faster):
  84 tcoffee(woodmouse,  MoreArgs = "-gapopen=-10 -gapext=-2")
  85 }}
  86 \keyword{manip}