File: as.alignment.Rd

package info (click to toggle)
r-cran-seqinr 3.4-5-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 5,876 kB
  • sloc: ansic: 1,987; makefile: 14
file content (38 lines) | stat: -rw-r--r-- 1,312 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
\name{as.alignment}
\alias{as.alignment}
\title{Constructor for class alignment}
\description{
Returns an object of (S3) class alignment. 
}
\usage{
as.alignment(nb = NULL, nam = NULL, seq = NULL, com = NULL)
}
\arguments{
  \item{nb}{integer. The number of sequences in the alignment.}
  \item{nam}{vector of \code{nb} character strings. The sequence names. }
  \item{seq}{vector of \code{nb} character strings. The aligned sequences.}
  \item{com}{vector of \code{nb} character strings. The comments about sequences.}
}

\value{
 An object of class \code{alignment} which is a list with the following components:
  \item{nb}{ the number of aligned sequences }
  \item{nam}{ a vector of strings containing the names of the aligned sequences } 
  \item{seq}{ a vector of strings containing the aligned sequences} 
  \item{com}{ a vector of strings containing the commentaries for each sequence or \code{NA} if there are no comments }
}
\references{ 
\code{citation("seqinr")}
}
\author{D. Charif, J.R. Lobry}
\seealso{
\code{\link{read.alignment}},
\code{\link{as.matrix.alignment}}, \code{\link{read.fasta}}, 
\code{\link{write.fasta}}, \code{\link{reverse.align}}, \code{\link{dist.alignment}}.

 }
\examples{
as.alignment(nb = 2, nam = c("one", "two"), 
  seq = c("-ACGT", "GACG-"), com = c("un", "deux"))
}