← Back to branch summary

~ubuntu-branches/ubuntu/wily/r-bioc-genomeinfodb/wily-proposed

« back to all changes in this revision

Viewing changes to man/GenomeDescription-class.Rd

  • Committer: Package Import Robot
  • Author(s): Andreas Tille
  • Date: 2015-05-09 22:01:45 UTC
  • mfrom: (1.2.1) (3.1.1 experimental)
  • Revision ID: package-import@ubuntu.com-20150509220145-mqmfymcczq9n1yr8
Tags: 1.4.0-1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/GenomeDescription-class.Rd
 
1
\name{GenomeDescription-class}
 
2
\docType{class}
 
3
 
 
4
% Classes
 
5
\alias{class:GenomeDescription}
 
6
\alias{GenomeDescription-class}
 
7
\alias{GenomeDescription}
 
8
 
 
9
% Accessor methods:
 
10
\alias{organism}
 
11
\alias{organism,GenomeDescription-method}
 
12
\alias{commonName}
 
13
\alias{commonName,GenomeDescription-method}
 
14
\alias{species}
 
15
\alias{species,GenomeDescription-method}
 
16
\alias{provider}
 
17
\alias{provider,GenomeDescription-method}
 
18
\alias{providerVersion}
 
19
\alias{providerVersion,GenomeDescription-method}
 
20
\alias{releaseDate}
 
21
\alias{releaseDate,GenomeDescription-method}
 
22
\alias{releaseName}
 
23
\alias{releaseName,GenomeDescription-method}
 
24
\alias{bsgenomeName}
 
25
\alias{bsgenomeName,GenomeDescription-method}
 
26
\alias{seqinfo,GenomeDescription-method}
 
27
\alias{seqnames,GenomeDescription-method}
 
28
 
 
29
% Standard generic methods:
 
30
\alias{show,GenomeDescription-method}
 
31
 
 
32
 
 
33
\title{GenomeDescription objects}
 
34
 
 
35
\description{
 
36
  A GenomeDescription object holds the meta information describing
 
37
  a given genome.
 
38
}
 
39
 
 
40
\details{
 
41
  In general the user will not need to manipulate directly a
 
42
  GenomeDescription instance but will manipulate instead a higher-level
 
43
  object that belongs to a class that extends the GenomeDescription class.
 
44
  For example, the top-level object defined in any BSgenome data package
 
45
  is a \link[BSgenome]{BSgenome} object and the \link[BSgenome]{BSgenome}
 
46
  class contains the GenomeDescription class. Thus a \link[BSgenome]{BSgenome}
 
47
  object is also a GenomeDescription object and can therefore be treated as
 
48
  such. In other words all the methods described below will work on it.
 
49
}
 
50
 
 
51
\section{Accessor methods}{
 
52
  In the code snippets below, \code{object} or \code{x} is a
 
53
  GenomeDescription object.
 
54
 
 
55
  \describe{
 
56
    \item{}{
 
57
      \code{organism(object)}:
 
58
      Return the scientific name of the organism of the genome e.g.
 
59
      \code{"Homo sapiens"}, \code{"Mus musculus"},
 
60
      \code{"Caenorhabditis elegans"}, etc...
 
61
    }
 
62
    \item{}{
 
63
      \code{commonName(object)}:
 
64
      Return the common name of the organism of the genome e.g.
 
65
      \code{"Human"}, \code{"Mouse"}, \code{"Worm"}, etc...
 
66
    }
 
67
    \item{}{
 
68
      \code{provider(x)}:
 
69
      Return the provider of this genome e.g. \code{"UCSC"}, \code{"BDGP"},
 
70
      \code{"FlyBase"}, etc...
 
71
    }
 
72
    \item{}{
 
73
      \code{providerVersion(x)}:
 
74
      Return the provider-side version of this genome.
 
75
      For example UCSC uses versions \code{"hg18"}, \code{"hg17"}, etc...
 
76
      for the different Builds of the Human genome.
 
77
    }
 
78
    \item{}{
 
79
      \code{releaseDate(x)}:
 
80
      Return the release date of this genome e.g. \code{"Mar. 2006"}.
 
81
    }
 
82
    \item{}{
 
83
      \code{releaseName(x)}:
 
84
      Return the release name of this genome, which is generally made of the
 
85
      name of the organization who assembled it plus its Build version.
 
86
      For example, UCSC uses \code{"hg18"} for the version of the
 
87
      Human genome corresponding to the Build 36.1 from NCBI hence
 
88
      the release name for this genome is \code{"NCBI Build 36.1"}.
 
89
    }
 
90
    \item{}{
 
91
      \code{bsgenomeName(x)}:
 
92
      Uses the meta information stored in \code{x} to make the name of
 
93
      the corresponding BSgenome data package (see the
 
94
      \code{\link[BSgenome]{available.genomes}} function in the \pkg{BSgenome}
 
95
      package for details about the naming scheme used for those packages).
 
96
      Of course there is no guarantee that a package with that name
 
97
      actually exists.
 
98
    }
 
99
    \item{\code{seqinfo(x)}}{
 
100
      Gets information about the genome sequences. This information
 
101
      is returned in a \link{Seqinfo} object.
 
102
      Each part of the information can be retrieved separately with
 
103
      \code{seqnames(x)}, \code{seqlengths(x)}, and \code{isCircular(x)},
 
104
      respectively, as described below.
 
105
    }
 
106
    \item{\code{seqnames(x)}}{
 
107
      Gets the names of the genome sequences.
 
108
      \code{seqnames(x)} is equivalent to \code{seqnames(seqinfo(x))}.
 
109
    }
 
110
    \item{\code{seqlengths(x)}}{
 
111
      Gets the lengths of the genome sequences.
 
112
      \code{seqlengths(x)} is equivalent to \code{seqlengths(seqinfo(x))}.
 
113
    }
 
114
    \item{\code{isCircular(x)}}{
 
115
      Returns the circularity flags of the genome sequences.
 
116
      \code{isCircular(x)} is equivalent to \code{isCircular(seqinfo(x))}.
 
117
    }
 
118
  }
 
119
}
 
120
 
 
121
\author{H. Pages}
 
122
 
 
123
\seealso{
 
124
  \itemize{
 
125
    \item The \code{\link[BSgenome]{available.genomes}} function and the
 
126
          \link[BSgenome]{BSgenome} class in the \pkg{BSgenome} package.
 
127
 
 
128
    \item The \link{Seqinfo} class.
 
129
  }
 
130
}
 
131
 
 
132
\examples{
 
133
library(BSgenome.Celegans.UCSC.ce2)
 
134
class(Celegans)
 
135
is(Celegans, "GenomeDescription")
 
136
provider(Celegans)
 
137
seqinfo(Celegans)
 
138
gendesc <- as(Celegans, "GenomeDescription")
 
139
class(gendesc)
 
140
gendesc
 
141
provider(gendesc)
 
142
seqinfo(gendesc)
 
143
bsgenomeName(gendesc)
 
144
}
 
145
 
 
146
\keyword{methods}
 
147
\keyword{classes}