File: organism.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 (40 lines) | stat: -rw-r--r-- 798 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
32
33
34
35
36
37
38
39
40
\name{organism}
\alias{organism}
\alias{organism,character-method}
\title{Convenience function for getting the organism from an object or package}

\description{
  The most basic organism method just takes a character string (which
  represents a particular annotation package) and returns the organism
  that said package is based upon.
}

\usage{
  organism(object)
}

\arguments{
  \item{object}{a character string that names a package}
}

\value{
  The name of the organism used for this package or object
}
  

\author{Marc Carlson}

\examples{
  require(hgu95av2.db)
  ## get the organism for this annotation package
  organism("hgu95av2")

  ## get the organism this object refers to
  ## (for a ChromLocation object)
  z <- buildChromLocation("hgu95av2")
  organism(z)

}

\keyword{manip}