File: SitePairSet-class.Rd

package info (click to toggle)
r-bioc-tfbstools 1.28.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 940 kB
  • sloc: xml: 1,137; ansic: 590; asm: 54; sh: 13; makefile: 2
file content (47 lines) | stat: -rw-r--r-- 990 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
39
40
41
42
43
44
45
46
47
\name{SitePairSet}
\Rdversion{1.1}
\docType{class}
\alias{SitePairSet}
\alias{SitePairSet-class}
\alias{length,SitePairSet-method}
\alias{as.data.frame,SitePairSet-method}
\alias{site1,SitePairSet-method}
\alias{site2,SitePairSet-method}

\title{Class \code{"SitePairSet"}}
\description{
  The SitePairSet object is a container for storing two SiteSet objects.
  Usually it is used to hold the results returned by \link{searchAln}.
}

\usage{
  ## Constructor
  SitePairSet(siteset1, siteset2)
}
\arguments{
  \item{siteset1, siteset2}{
    Each SiteSet object is from one sequence in the pairwise alignment.
  }
}

\section{Methods}{
  \describe{
    \item{siteset1}{\code{signature(x = "SitePairSet")}: Gets the first SiteSet object.}
    \item{siteset2}{\code{signature(x = "SitePairSet")}: Gets the second SiteSet object.}
  }
}

\value{
  A \code{\link{SitePairSet}} object.
}

\author{
  Ge Tan
}

\seealso{
  \code{\link{SitePairSet}},
  \code{\link{searchAln}}
}

\keyword{classes}