File: XMatrixList-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 (80 lines) | stat: -rw-r--r-- 1,941 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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
\name{XMatrixList}
\Rdversion{1.1}
\docType{class}
\alias{XMatrixList}
\alias{XMatrixList,list-method}
\alias{PFMatrixList}
\alias{PFMatrixList-class}
\alias{PWMatrixList}
\alias{PWMatrixList-class}
\alias{ICMatrixList}
\alias{ICMatrixList-class}
\alias{bg,XMatrixList-method}
\alias{ID,XMatrixList-method}
\alias{Matrix,XMatrixList-method}
\alias{matrixClass,XMatrixList-method}
\alias{matrixType,XMatrixList-method}
\alias{name,XMatrixList-method}
\alias{strand,XMatrixList-method}
\alias{tags,XMatrixList-method}
\alias{showAsCell,XMatrixList-method}

\title{Class \code{"XMatrixList"}}
\description{
  The XMatrixList virtual class is a container for storing a collection of XMatrix objects.
  No object can be constructed directly from this virtual and it has three subclasses: PFMatrixList, PWMatrixList and ICMatrixList.
  Basically it is a SimpleList and is designed for manipulating the set of XMatrix objects as a whole.
}

\usage{
## Constructors:
PFMatrixList(..., use.names=TRUE)
PWMatrixList(..., use.names=TRUE)
ICMatrixList(..., use.names=TRUE)

## Accessor-like methods:
\S4method{ID}{XMatrixList}(x)
\S4method{name}{XMatrixList}(x)
\S4method{bg}{XMatrixList}(x)
\S4method{tags}{XMatrixList}(x)
\S4method{name}{XMatrixList}(x)
\S4method{strand}{XMatrixList}(x)
}

\arguments{
  \item{...}{
    The \code{XMatrix} objects are supplied in ....
  }
  \item{use.names}{
    A logical value. When TRUE, the names of the \code{XMatrix} will be kept.
  }
  \item{x}{
    A \code{XMatrixList} object.
  }
}

\value{
  A \code{XMatrixList} object.
}

\author{
  Ge Tan
}


\seealso{
  \code{\link{XMatrix}},
}

\examples{
    data(MA0003.2)
    data(MA0004.1)
    
    ## Construction of PFMatrixList
    pfmList <- PFMatrixList(pfm1=MA0003.2, pfm2=MA0004.1, use.names=TRUE)
    
    ## Construction of PFM<atrixList from list of PFMatrix
    pfmList <- do.call(PFMatrixList, list(pfm1=MA0003.2, pfm2=MA0004.1))
}
\keyword{classes}