File: readJASPARMatrix.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-- 1,327 bytes parent folder | download | duplicates (3)
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{readJASPARMatrix}
\alias{readJASPARMatrix}

\title{
  Read JASPAR format matrix
}
\description{
  Read a JASPAR format matrix file with \sQuote{individual} matrix or
  \sQuote{all} matrices in one file.
}
\usage{
  readJASPARMatrix(fn, matrixClass=c("PFM", "PWM", "PWMProb"))
}
\arguments{
  \item{fn}{
    \code{character}(1): The filename of JASPAR format matrix file.
  }
  \item{matrixClass}{
    \code{character}(1): the matrices in the files are \sQuote{PFM}, \sQuote{PWM} or
    \sQuote{PFM} in probability.
  }
}
\details{
  An example of \sQuote{individual} format matrix file is available at 
  \url{http://jaspar.genereg.net/html/DOWNLOAD/JASPAR_CORE/pfm/individual/MA0001.1.pfm}
  
  An exmaple of \sQuote{all} format matrix file is available at 
  \url{http://jaspar.genereg.net/html/DOWNLOAD/JASPAR_CORE/pfm/nonredundant/pfm_all.txt}
}
\value{
  A \code{PFMatrixList} or \code{PWMatrixList} object is returned, depending on the
  matrix class.
}
\author{
  Ge Tan
}
\seealso{
  \code{\link{makeFlatFileDir}}
}
\examples{
  fn <- file.path(system.file("extdata", package="TFBSTools"),
                  "MA0001.1.pfm")
  readJASPARMatrix(fn, matrixClass="PFM")
  fn <- file.path(system.file("extdata", package="TFBSTools"),
                  "pfm_all_example.txt")
  readJASPARMatrix(fn, matrixClass="PFM")
}