File: buildChromLocation.Rd

package info (click to toggle)
r-bioc-annotate 1.84.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,624 kB
  • sloc: makefile: 2
file content (31 lines) | stat: -rw-r--r-- 877 bytes parent folder | download | duplicates (5)
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
\name{buildChromLocation}
\alias{buildChromLocation}
\title{A function to generate an instantiation of a chromLocation class}
\description{
  This function will take the name of a data package and build a
  chromLocation object representing that data set.
}
\usage{
  buildChromLocation(dataPkg)
}
\arguments{
  \item{dataPkg}{The name of the data package to be used}
}
\details{
  The requested data set must be available in the user's
  \code{.libPaths()}, and the function will throw an error if this is
  not the case.

  If the data package is present, the necessary information will be
  extracted from the data package and a \code{chromLocation} object will
  be created.
}
\value{
  A \code{chromLocation} object representing the specified data set.
}
\author{Jeff Gentry}
\examples{
  library("hgu95av2.db")
  z <- buildChromLocation("hgu95av2")
}
\keyword{utilities}