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