Browse code

update AnnDbPkg template man to reference select() interface

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/AnnotationForge@109954 bc3139a8-67e5-0310-9ffc-ced21a209358

Valerie Obenchain authored on 27/10/2015 02:29:44
Showing 54 changed files

... ...
@@ -3,7 +3,7 @@ Title: Code for Building Annotation Database Packages
3 3
 Description: Provides code for generating Annotation packages and
4 4
 	     their databases.  Packages produced are intended to be
5 5
 	     used with AnnotationDbi.
6
-Version: 1.13.1
6
+Version: 1.13.2
7 7
 Author: Marc Carlson, Herve Pages
8 8
 Maintainer: Bioconductor Package Maintainer <maintainer@bioconductor.org>
9 9
 Depends: R (>= 2.7.0), methods, utils, BiocGenerics (>= 0.15.10),
... ...
@@ -15,19 +15,31 @@
15 15
   \url{http://www.genome.ad.jp/kegg/}
16 16
 }
17 17
 
18
-\examples{
19
-  x <- @ANNOBJPREFIX@ARACYC
20
-  # Get the tair identifiers that are mapped to pathways
21
-  mapped_tairs <- mappedkeys(x)
22
-  # Convert to a list
23
-  xx <- as.list(x[mapped_tairs])
24
-  if(length(xx) > 0) {
25
-    # Get the pathways for the first five tairs
26
-    xx[1:5]
27
-    # For the first tair
28
-    xx[[1]]
18
+\seealso{
19
+  \itemize{
20
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
21
+          the \code{select()} interface.
29 22
   }
30 23
 }
31 24
 
25
+\examples{
26
+## select() interface:
27
+## Objects in this package can be accessed using the select() interface
28
+## from the AnnotationDbi package. See ?select for details.
29
+
30
+## Bimap interface:
31
+x <- @ANNOBJPREFIX@ARACYC
32
+# Get the tair identifiers that are mapped to pathways
33
+mapped_tairs <- mappedkeys(x)
34
+# Convert to a list
35
+xx <- as.list(x[mapped_tairs])
36
+if(length(xx) > 0) {
37
+  # Get the pathways for the first five tairs
38
+  xx[1:5]
39
+  # For the first tair
40
+  xx[[1]]
41
+}
42
+}
43
+
32 44
 \keyword{datasets}
33 45
 
... ...
@@ -5,6 +5,7 @@
5 5
   @ANNOBJPREFIX@ARACYCENZYME is an R object that provides mappings between
6 6
   TAIR identifiers and Enzyme Names from ARACYC. 
7 7
 }
8
+
8 9
 \details{
9 10
   Each TAIR identifier maps to a named vector containing the
10 11
   Enzyme name for that gene according to the ARACYC database.  If this
... ...
@@ -13,18 +14,31 @@
13 14
   Mappings between tair identifiers and enzyme identifiers were obtained using files
14 15
   provided by: @ENZYMESOURCE@
15 16
 }
17
+
18
+\seealso{
19
+  \itemize{
20
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
21
+          the \code{select()} interface.
22
+  }
23
+}
24
+
16 25
 \examples{
17
-        x <- @ANNOBJPREFIX@ARACYCENZYME
18
-        # Get the tair identifiers that are mapped to an Enzyme Name 
19
-        mapped_tairs <- mappedkeys(x)
20
-        # Convert to a list
21
-        xx <- as.list(x[mapped_tairs])
22
-        if(length(xx) > 0) {
23
-          # Get the ENZYME name for the first five tairs
24
-          xx[1:5]
25
-          # Get the first one
26
-          xx[[1]]
27
-        }
26
+## select() interface:
27
+## Objects in this package can be accessed using the select() interface
28
+## from the AnnotationDbi package. See ?select for details.
29
+
30
+## Bimap interface:
31
+x <- @ANNOBJPREFIX@ARACYCENZYME
32
+# Get the tair identifiers that are mapped to an Enzyme Name 
33
+mapped_tairs <- mappedkeys(x)
34
+# Convert to a list
35
+xx <- as.list(x[mapped_tairs])
36
+if(length(xx) > 0) {
37
+  # Get the ENZYME name for the first five tairs
38
+  xx[1:5]
39
+  # Get the first one
40
+  xx[[1]]
41
+}
28 42
 }
29 43
 \keyword{datasets}
30 44
 
... ...
@@ -8,14 +8,27 @@
8 8
   this package is to provide detailed information about the
9 9
   @ANNOBJPREFIX@ platform. This package is updated biannually.
10 10
   
11
-  You can learn what objects this package supports with the following command:
11
+  Objects in this package are accessed using the \code{select()} interface.
12
+  See ?select in the AnnotationDbi package for details.
13
+}
12 14
 
13
-  \code{ls("package:@ANNOBJPREFIX@.db")} 
14
-  
15
-  Each of these objects has their own manual page detailing where
16
-  relevant data was obtained along with some examples of how to use it.
15
+\seealso{
16
+  \itemize{
17
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
18
+          \code{keys()}, \code{columns()} and \code{select()}.
19
+  }
17 20
 }
21
+
18 22
 \examples{
19
-  ls("package:@ANNOBJPREFIX@.db")
23
+## select() interface:
24
+## Objects in this package can be accessed using the select() interface
25
+## from the AnnotationDbi package. See ?select for details.
26
+columns(@ANNOBJPREFIX@.db)
27
+
28
+## Bimap interface:
29
+## The 'old style' of interacting with these objects is manipulation as 
30
+## bimaps. While this approach is still available we strongly encourage the
31
+## use of select().
32
+ls("package:@ANNOBJPREFIX@.db")
20 33
 }
21 34
 \keyword{datasets}
... ...
@@ -16,18 +16,30 @@
16 16
   
17 17
 }
18 18
 
19
+\seealso{
20
+  \itemize{
21
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
22
+          the \code{select()} interface.
23
+  }
24
+}
25
+
19 26
 \examples{
20
-        x <- @ANNOBJPREFIX@CHR
21
-        # Get the tair identifiers that are mapped to a chromosome
22
-        mapped_tairs <- mappedkeys(x)
23
-        # Convert to a list
24
-        xx <- as.list(x[mapped_tairs])
25
-        if(length(xx) > 0) {
26
-          # Get the CHR for the first five tairs
27
-          xx[1:5]
28
-          # Get the first one
29
-          xx[[1]]
30
-        }
27
+## select() interface:
28
+## Objects in this package can be accessed using the select() interface
29
+## from the AnnotationDbi package. See ?select for details.
30
+
31
+## Bimap interface:
32
+x <- @ANNOBJPREFIX@CHR
33
+# Get the tair identifiers that are mapped to a chromosome
34
+mapped_tairs <- mappedkeys(x)
35
+# Convert to a list
36
+xx <- as.list(x[mapped_tairs])
37
+if(length(xx) > 0) {
38
+  # Get the CHR for the first five tairs
39
+  xx[1:5]
40
+  # Get the first one
41
+  xx[[1]]
42
+}
31 43
 }
32 44
 \keyword{datasets}
33 45
 
... ...
@@ -5,6 +5,7 @@
5 5
   @ANNOBJPREFIX@CHRLENGTHS provides the length measured in base pairs for
6 6
   each of the chromosomes. 
7 7
 }
8
+
8 9
 \details{
9 10
    This is a named vector with chromosome numbers as the names and the
10 11
    corresponding lengths for chromosomes as the values.
... ...
@@ -13,10 +14,23 @@
13 14
    number of base pairs on the sequence string for each chromosome.
14 15
 
15 16
 }
17
+
18
+\seealso{
19
+  \itemize{
20
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
21
+          the \code{select()} interface.
22
+  }
23
+}
24
+
16 25
 \examples{
17
-    tt <- @ANNOBJPREFIX@CHRLENGTHS
18
-    # Length of chromosome 1
19
-    tt["1"]
26
+## select() interface:
27
+## Objects in this package can be accessed using the select() interface
28
+## from the AnnotationDbi package. See ?select for details.
29
+
30
+## Bimap interface:
31
+tt <- @ANNOBJPREFIX@CHRLENGTHS
32
+# Length of chromosome 1
33
+tt["1"]
20 34
 }
21 35
 \keyword{datasets}
22 36
 
... ...
@@ -25,18 +25,31 @@
25 25
   Mappings were based on data provided by: @CHRLOCSOURCE@
26 26
   
27 27
 }
28
+
29
+\seealso{
30
+  \itemize{
31
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
32
+          the \code{select()} interface.
33
+  }
34
+}
35
+
28 36
 \examples{
29
-        x <- @ANNOBJPREFIX@CHRLOC
30
-        # Get the tair identifiers that are mapped to chromosome locations
31
-        mapped_tairs <- mappedkeys(x)
32
-        # Convert to a list
33
-        xx <- as.list(x[mapped_tairs])
34
-        if(length(xx) > 0) {
35
-          # Get the CHRLOC for the first five tairs
36
-          xx[1:5]
37
-          # Get the first one
38
-          xx[[1]]
39
-        }
37
+## select() interface:
38
+## Objects in this package can be accessed using the select() interface
39
+## from the AnnotationDbi package. See ?select for details.
40
+
41
+## Bimap interface:
42
+x <- @ANNOBJPREFIX@CHRLOC
43
+# Get the tair identifiers that are mapped to chromosome locations
44
+mapped_tairs <- mappedkeys(x)
45
+# Convert to a list
46
+xx <- as.list(x[mapped_tairs])
47
+if(length(xx) > 0) {
48
+  # Get the CHRLOC for the first five tairs
49
+  xx[1:5]
50
+  # Get the first one
51
+  xx[[1]]
52
+}
40 53
 }
41 54
 \keyword{datasets}
42 55
 
... ...
@@ -14,18 +14,30 @@
14 14
   \url{ftp://ftp.ncbi.nlm.nih.gov/gene/DATA}
15 15
 }
16 16
 
17
+\seealso{
18
+  \itemize{
19
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
20
+          the \code{select()} interface.
21
+  }
22
+}
23
+
17 24
 \examples{
18
-    x <- @ANNOBJPREFIX@ENTREZID
19
-    # Get the ORF IDs that are mapped to an Entrez Gene ID
20
-    mapped_genes <- mappedkeys(x)
21
-    # Convert to a list
22
-    xx <- as.list(x[mapped_genes])
23
-    if(length(xx) > 0) {
24
-      # Get the Entrez gene IDs for the first five genes
25
-      xx[1:5]
26
-      # Get the first one
27
-      xx[[1]]
28
-    }
25
+## select() interface:
26
+## Objects in this package can be accessed using the select() interface
27
+## from the AnnotationDbi package. See ?select for details.
28
+
29
+## Bimap interface:
30
+x <- @ANNOBJPREFIX@ENTREZID
31
+# Get the ORF IDs that are mapped to an Entrez Gene ID
32
+mapped_genes <- mappedkeys(x)
33
+# Convert to a list
34
+xx <- as.list(x[mapped_genes])
35
+if(length(xx) > 0) {
36
+  # Get the Entrez gene IDs for the first five genes
37
+  xx[1:5]
38
+  # Get the first one
39
+  xx[[1]]
40
+}
29 41
 }
30 42
 \keyword{datasets}
31 43
 
... ...
@@ -47,18 +47,31 @@
47 47
 \references{
48 48
 \url{ftp://ftp.genome.ad.jp/pub/kegg/pathways}
49 49
 }
50
+
51
+\seealso{
52
+  \itemize{
53
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
54
+          the \code{select()} interface.
55
+  }
56
+}
57
+
50 58
 \examples{
51
-        x <- @ANNOBJPREFIX@ENZYME
52
-        # Get the TAIR identifiers that are mapped to an EC number 
53
-        mapped_tairs <- mappedkeys(x)
54
-        # Convert to a list
55
-        xx <- as.list(x[mapped_tairs])
56
-        if(length(xx) > 0) {
57
-          # Get the ENZYME for the first five tairs
58
-          xx[1:5]
59
-          # Get the first one
60
-          xx[[1]]
61
-        }
59
+## select() interface:
60
+## Objects in this package can be accessed using the select() interface
61
+## from the AnnotationDbi package. See ?select for details.
62
+
63
+## Bimap interface:
64
+x <- @ANNOBJPREFIX@ENZYME
65
+# Get the TAIR identifiers that are mapped to an EC number 
66
+mapped_tairs <- mappedkeys(x)
67
+# Convert to a list
68
+xx <- as.list(x[mapped_tairs])
69
+if(length(xx) > 0) {
70
+  # Get the ENZYME for the first five tairs
71
+  xx[1:5]
72
+  # Get the first one
73
+  xx[[1]]
74
+}
62 75
 }
63 76
 \keyword{datasets}
64 77
 
... ...
@@ -46,15 +46,20 @@
46 46
 \url{ftp://ftp.genome.ad.jp/pub/kegg/pathways}
47 47
 }
48 48
 \examples{
49
-    # Convert to a list
50
-    xx <- as.list(@ANNOBJPREFIX@ENZYME2TAIR)
51
-   if(length(xx) > 0){
52
-       # Gets the tair identifiers for the first five enzyme
53
-       #commission numbers
54
-       xx[1:5]
55
-       # Get the first one
56
-       xx[[1]]
57
-    }
49
+## select() interface:
50
+## Objects in this package can be accessed using the select() interface
51
+## from the AnnotationDbi package. See ?select for details.
52
+
53
+## Bimap interface:
54
+# Convert to a list
55
+xx <- as.list(@ANNOBJPREFIX@ENZYME2TAIR)
56
+if(length(xx) > 0){
57
+    # Gets the tair identifiers for the first five enzyme
58
+    #commission numbers
59
+    xx[1:5]
60
+    # Get the first one
61
+    xx[[1]]
62
+}
58 63
 }
59 64
 \keyword{datasets}
60 65
 
... ...
@@ -5,6 +5,7 @@
5 5
   @ANNOBJPREFIX@GENENAME is an R object that maps TAIR
6 6
   identifiers to the corresponding gene name.
7 7
 }
8
+
8 9
 \details{
9 10
   Each TAIR identifier maps to a named vector containing the gene
10 11
   name. The vector name corresponds to the TAIR identifier. If
... ...
@@ -19,18 +20,30 @@
19 20
   
20 21
 }
21 22
 
23
+\seealso{
24
+  \itemize{
25
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
26
+          the \code{select()} interface.
27
+  }
28
+}
29
+
22 30
 \examples{
23
-        x <- @ANNOBJPREFIX@GENENAME
24
-        # Get the TAIR identifiers that are mapped to a gene name
25
-        mapped_tairs <- mappedkeys(x)
26
-        # Convert to a list
27
-        xx <- as.list(x[mapped_tairs])
28
-        if(length(xx) > 0) {
29
-          # Get the GENENAME for the first five tairs
30
-          xx[1:5]
31
-          # Get the first one
32
-          xx[[1]]
33
-        }
31
+## select() interface:
32
+## Objects in this package can be accessed using the select() interface
33
+## from the AnnotationDbi package. See ?select for details.
34
+
35
+## Bimap interface:
36
+x <- @ANNOBJPREFIX@GENENAME
37
+# Get the TAIR identifiers that are mapped to a gene name
38
+mapped_tairs <- mappedkeys(x)
39
+# Convert to a list
40
+xx <- as.list(x[mapped_tairs])
41
+if(length(xx) > 0) {
42
+  # Get the GENENAME for the first five tairs
43
+  xx[1:5]
44
+  # Get the first one
45
+  xx[[1]]
46
+}
34 47
 }
35 48
 \keyword{datasets}
36 49
 
... ...
@@ -69,35 +69,47 @@
69 69
   Ontology terms and other information are available in a separate data
70 70
   package named GO.
71 71
 }
72
-\seealso{
73
-  \code{\link{@ANNOBJPREFIX@GO2ALLTAIRS}}.
74
-}
72
+
75 73
 \references{
76 74
 \url{ftp://ftp.ncbi.nlm.nih.gov/gene/DATA/}
77 75
 }
76
+
77
+\seealso{
78
+  \itemize{
79
+    \item \code{\link{@ANNOBJPREFIX@GO2ALLTAIRS}}.
80
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
81
+          the \code{select()} interface.
82
+  }
83
+}
84
+
78 85
 \examples{
79
-    x <- @ANNOBJPREFIX@GO
80
-    # Get the TAIR gene identifiers that are mapped to a GO ID
81
-    mapped_genes <- mappedkeys(x)
82
-    # Convert to a list
83
-    xx <- as.list(x[mapped_genes])
84
-    if(length(xx) > 0) {
85
-        # Try the first one
86
-        got <- xx[[1]]           
87
-        got[[1]][["GOID"]]
88
-        got[[1]][["Ontology"]]
89
-        got[[1]][["Evidence"]]
90
-    }
91
-    # For the reverse map:
92
-    # Convert to a list
93
-    xx <- as.list(@ANNOBJPREFIX@GO2TAIR)
94
-    if(length(xx) > 0){
95
-        # Gets the TAIR gene ids for the top 2nd and 3nd GO identifiers
96
-        goids <- xx[2:3]
97
-        # Gets the TAIR ids for the first element of goids
98
-        goids[[1]]
99
-        # Evidence code for the mappings
100
-        names(goids[[1]])
101
-    }
86
+## select() interface:
87
+## Objects in this package can be accessed using the select() interface
88
+## from the AnnotationDbi package. See ?select for details.
89
+
90
+## Bimap interface:
91
+x <- @ANNOBJPREFIX@GO
92
+# Get the TAIR gene identifiers that are mapped to a GO ID
93
+mapped_genes <- mappedkeys(x)
94
+# Convert to a list
95
+xx <- as.list(x[mapped_genes])
96
+if(length(xx) > 0) {
97
+    # Try the first one
98
+    got <- xx[[1]]           
99
+    got[[1]][["GOID"]]
100
+    got[[1]][["Ontology"]]
101
+    got[[1]][["Evidence"]]
102
+}
103
+# For the reverse map:
104
+# Convert to a list
105
+xx <- as.list(@ANNOBJPREFIX@GO2TAIR)
106
+if(length(xx) > 0){
107
+    # Gets the TAIR gene ids for the top 2nd and 3nd GO identifiers
108
+    goids <- xx[2:3]
109
+    # Gets the TAIR ids for the first element of goids
110
+    goids[[1]]
111
+    # Evidence code for the mappings
112
+    names(goids[[1]])
113
+}
102 114
 }
103 115
 \keyword{datasets}
... ...
@@ -61,20 +61,34 @@
61 61
   relationships indicate that the genes from the child terms would be
62 62
   the same kind of thing.
63 63
 }
64
+
64 65
 \references{
65 66
 \url{ftp://ftp.ncbi.nlm.nih.gov/gene/DATA/}
66 67
 }
68
+
69
+\seealso{
70
+  \itemize{
71
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
72
+          the \code{select()} interface.
73
+  }
74
+}
75
+
67 76
 \examples{
68
-    # Convert to a list
69
-    xx <- as.list(@ANNOBJPREFIX@GO2ALLTAIRS)
70
-    if(length(xx) > 0){
71
-        # Gets the tair identifiers for the top 2nd and 3nd GO identifiers
72
-        goids <- xx[2:3]
73
-        # Gets all the tair identifiers for the first element of goids
74
-        goids[[1]]
75
-        # Evidence code for the mappings
76
-        names(goids[[1]])
77
-    }
77
+## select() interface:
78
+## Objects in this package can be accessed using the select() interface
79
+## from the AnnotationDbi package. See ?select for details.
80
+
81
+## Bimap interface:
82
+# Convert to a list
83
+xx <- as.list(@ANNOBJPREFIX@GO2ALLTAIRS)
84
+if(length(xx) > 0){
85
+    # Gets the tair identifiers for the top 2nd and 3nd GO identifiers
86
+    goids <- xx[2:3]
87
+    # Gets all the tair identifiers for the first element of goids
88
+    goids[[1]]
89
+    # Evidence code for the mappings
90
+    names(goids[[1]])
91
+}
78 92
 }
79 93
 \keyword{datasets}
80 94
 
... ...
@@ -21,21 +21,30 @@
21 21
 }
22 22
 
23 23
 \seealso{
24
-  \code{\link[AnnotationDbi:Bimap-keys]{mappedkeys}},
25
-  \code{\link[AnnotationDbi:Bimap-keys]{count.mappedkeys}},
26
-  \code{\link[AnnotationDbi:AnnDbPkg-checker]{checkMAPCOUNTS}}
24
+  \itemize{
25
+    \item \code{\link[AnnotationDbi:Bimap-keys]{mappedkeys}}
26
+    \item \code{\link[AnnotationDbi:Bimap-keys]{count.mappedkeys}}
27
+    \item \code{\link[AnnotationDbi:AnnDbPkg-checker]{checkMAPCOUNTS}}
28
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
29
+          the \code{select()} interface.
30
+  }
27 31
 }
28 32
 
29 33
 \examples{
30
-  @ANNOBJPREFIX@MAPCOUNTS
31
-  mapnames <- names(@ANNOBJPREFIX@MAPCOUNTS)
32
-  @ANNOBJPREFIX@MAPCOUNTS[mapnames[1]]
33
-  x <- get(mapnames[1])
34
-  sum(!is.na(as.list(x)))
35
-  count.mappedkeys(x)   # much faster!
36
-
37
-  ## Check the "map count" of all the maps in package @PKGNAME@
38
-  checkMAPCOUNTS("@PKGNAME@")
34
+## select() interface:
35
+## Objects in this package can be accessed using the select() interface
36
+## from the AnnotationDbi package. See ?select for details.
37
+
38
+## Bimap interface:
39
+@ANNOBJPREFIX@MAPCOUNTS
40
+mapnames <- names(@ANNOBJPREFIX@MAPCOUNTS)
41
+@ANNOBJPREFIX@MAPCOUNTS[mapnames[1]]
42
+x <- get(mapnames[1])
43
+sum(!is.na(as.list(x)))
44
+count.mappedkeys(x)   # much faster!
45
+
46
+## Check the "map count" of all the maps in package @PKGNAME@
47
+checkMAPCOUNTS("@PKGNAME@")
39 48
 }
40 49
 
41 50
 \keyword{datasets}
... ...
@@ -5,13 +5,27 @@
5 5
   @ANNOBJPREFIX@ORGANISM is an R object that contains a single item: a
6 6
   character string that names the organism for which @ANNOBJPREFIX@ was built.
7 7
 }
8
+
8 9
 \details{
9 10
   Although the package name is suggestive of the organism for which it
10 11
   was built, @ANNOBJPREFIX@ORGANISM provides a simple way to programmatically
11 12
   extract the organism name.
12 13
 }
14
+
15
+\seealso{
16
+  \itemize{
17
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
18
+          the \code{select()} interface.
19
+  }
20
+}
21
+
13 22
 \examples{
14
-  @ANNOBJPREFIX@ORGANISM
23
+## select() interface:
24
+## Objects in this package can be accessed using the select() interface
25
+## from the AnnotationDbi package. See ?select for details.
26
+
27
+## Bimap interface:
28
+@ANNOBJPREFIX@ORGANISM
15 29
 }
16 30
 \keyword{datasets}
17 31
 
... ...
@@ -23,18 +23,31 @@
23 23
 \references{
24 24
   \url{http://www.genome.ad.jp/kegg/}
25 25
 }
26
+
27
+\seealso{
28
+  \itemize{
29
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
30
+          the \code{select()} interface.
31
+  }
32
+}
33
+
26 34
 \examples{
27
-        x <- @ANNOBJPREFIX@PATH
28
-        # Get the TAIR identifiers that are mapped to a KEGG pathway ID
29
-        mapped_genes <- mappedkeys(x)
30
-        # Convert to a list
31
-        xx <- as.list(x[mapped_genes])
32
-        if(length(xx) > 0) {
33
-          # Get the PATH for the first five genes
34
-          xx[1:5]
35
-          # Get the first one
36
-          xx[[1]]
37
-        }
35
+## select() interface:
36
+## Objects in this package can be accessed using the select() interface
37
+## from the AnnotationDbi package. See ?select for details.
38
+
39
+## Bimap interface:
40
+x <- @ANNOBJPREFIX@PATH
41
+# Get the TAIR identifiers that are mapped to a KEGG pathway ID
42
+mapped_genes <- mappedkeys(x)
43
+# Convert to a list
44
+xx <- as.list(x[mapped_genes])
45
+if(length(xx) > 0) {
46
+  # Get the PATH for the first five genes
47
+  xx[1:5]
48
+  # Get the first one
49
+  xx[[1]]
50
+}
38 51
 }
39 52
 \keyword{datasets}
40 53
 
... ...
@@ -24,20 +24,34 @@
24 24
   Mappings were based on data provided by: @PATH2TAIRSOURCE@
25 25
 
26 26
 }
27
+
27 28
 \references{
28 29
 \url{http://www.genome.ad.jp/kegg/}
29 30
 }
31
+
32
+\seealso{
33
+  \itemize{
34
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
35
+          the \code{select()} interface.
36
+  }
37
+}
38
+
30 39
 \examples{
31
-    # Convert the object to a list
32
-    xx <- as.list(@ANNOBJPREFIX@PATH2TAIR)
33
-    # Remove pathway identifiers that do not map to any tair id
34
-    xx <- xx[!is.na(xx)]
35
-    if(length(xx) > 0){
36
-        # The tair identifiers for the first two elements of XX
37
-        xx[1:2]
38
-        # Get the first one
39
-        xx[[1]]
40
-    } 
40
+## select() interface:
41
+## Objects in this package can be accessed using the select() interface
42
+## from the AnnotationDbi package. See ?select for details.
43
+
44
+## Bimap interface:
45
+# Convert the object to a list
46
+xx <- as.list(@ANNOBJPREFIX@PATH2TAIR)
47
+# Remove pathway identifiers that do not map to any tair id
48
+xx <- xx[!is.na(xx)]
49
+if(length(xx) > 0){
50
+    # The tair identifiers for the first two elements of XX
51
+    xx[1:2]
52
+    # Get the first one
53
+    xx[[1]]
54
+} 
41 55
 }
42 56
 
43 57
 \keyword{datasets}
... ...
@@ -20,28 +20,42 @@
20 20
   Mappings were based on data provided by: @PMIDSOURCE@
21 21
 
22 22
 }
23
+
23 24
 \references{
24 25
   \url{http://www.ncbi.nlm.nih.gov/entrez/query.fcgi?db=PubMed}
25 26
 }
27
+
28
+\seealso{
29
+  \itemize{
30
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
31
+          the \code{select()} interface.
32
+  }
33
+}
34
+
26 35
 \examples{
27
-        x <- @ANNOBJPREFIX@PMID
28
-        # Get the tair identifiers that are mapped to any PubMed ID
29
-        mapped_genes <- mappedkeys(x)
30
-        # Convert to a list
31
-        xx <- as.list(x[mapped_genes])
32
-    if(length(xx) > 0){
33
-        # The tair identifiers for the first two elements of XX
34
-        xx[1:2]
35
-        # Get the first one
36
-        xx[[1]]
37
-        if(interactive() && !is.null(xx[[1]]) && !is.na(xx[[1]])
38
-           && require(annotate)){
39
-            # Gets article information as XML files
40
-            xmls <- pubmed(xx[[1]], disp = "data")
41
-            # Views article information using a browser
42
-            pubmed(xx[[1]], disp = "browser")
43
-        }
36
+## select() interface:
37
+## Objects in this package can be accessed using the select() interface
38
+## from the AnnotationDbi package. See ?select for details.
39
+
40
+## Bimap interface:
41
+x <- @ANNOBJPREFIX@PMID
42
+# Get the tair identifiers that are mapped to any PubMed ID
43
+mapped_genes <- mappedkeys(x)
44
+# Convert to a list
45
+xx <- as.list(x[mapped_genes])
46
+if(length(xx) > 0){
47
+    # The tair identifiers for the first two elements of XX
48
+    xx[1:2]
49
+    # Get the first one
50
+    xx[[1]]
51
+    if(interactive() && !is.null(xx[[1]]) && !is.na(xx[[1]])
52
+        && require(annotate)){
53
+        # Gets article information as XML files
54
+        xmls <- pubmed(xx[[1]], disp = "data")
55
+        # Views article information using a browser
56
+        pubmed(xx[[1]], disp = "browser")
44 57
     }
45 58
 }
59
+}
46 60
 \keyword{datasets}
47 61
 
... ...
@@ -20,22 +20,34 @@
20 20
   
21 21
 }
22 22
 
23
+\seealso{
24
+  \itemize{
25
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
26
+          the \code{select()} interface.
27
+  }
28
+}
29
+
23 30
 \examples{
24
-    # Convert the object to a list
25
-    xx <- as.list(@ANNOBJPREFIX@PMID2TAIR)
26
-    if(length(xx) > 0){
27
-        # The tair identifiers for the first two elements of XX
28
-        xx[1:2]
29
-        # Get the first one
30
-        xx[[1]]
31
-        if(interactive() && require(annotate)){
32
-            # Gets article information as XML files for a PubMed id
33
-            xmls <- pubmed(names(xx)[1], disp = "data")
34
-            # Views article information using a browser
35
-            pubmed(names(xx)[1], disp = "browser")
36
-        }
31
+## select() interface:
32
+## Objects in this package can be accessed using the select() interface
33
+## from the AnnotationDbi package. See ?select for details.
34
+
35
+## Bimap interface:
36
+# Convert the object to a list
37
+xx <- as.list(@ANNOBJPREFIX@PMID2TAIR)
38
+if(length(xx) > 0){
39
+    # The tair identifiers for the first two elements of XX
40
+    xx[1:2]
41
+    # Get the first one
42
+    xx[[1]]
43
+    if(interactive() && require(annotate)){
44
+        # Gets article information as XML files for a PubMed id
45
+        xmls <- pubmed(names(xx)[1], disp = "data")
46
+        # Views article information using a browser
47
+        pubmed(names(xx)[1], disp = "browser")
37 48
     }
38 49
 }
50
+}
39 51
 
40 52
 \keyword{datasets}
41 53
 
... ...
@@ -42,35 +42,49 @@
42 42
   \url{ftp://ftp.ncbi.nlm.nih.gov/gene/DATA}
43 43
 
44 44
 }
45
+
45 46
 \references{
46 47
     \url{http://www.ncbi.nlm.nih.gov}
47 48
     \url{http://www.ncbi.nlm.nih.gov/RefSeq/} 
48 49
 }
50
+
51
+\seealso{
52
+  \itemize{
53
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
54
+          the \code{select()} interface.
55
+  }
56
+}
57
+
49 58
 \examples{
50
-        x <- @ANNOBJPREFIX@REFSEQ
51
-        # Get the TAIR identifiers that are mapped to any RefSeq ID
52
-        mapped_genes <- mappedkeys(x)
53
-        # Convert to a list
54
-        xx <- as.list(x[mapped_genes])
55
-        if(length(xx) > 0) {
56
-          # Get the REFSEQ for the first five genes
57
-          xx[1:5]
58
-          # Get the first one
59
-          xx[[1]]
60
-        }
61
-
62
-        # For the reverse map:
63
-        x <- @ANNOBJPREFIX@REFSEQ2TAIR
64
-        # Get the RefSeq identifier that are mapped to an TAIR ID
65
-        mapped_seqs <- mappedkeys(x)
66
-        # Convert to a list
67
-        xx <- as.list(x[mapped_seqs])
68
-        if(length(xx) > 0) {
69
-          # Get the TAIR ID for the first five Refseqs
70
-          xx[1:5]
71
-          # Get the first one
72
-          xx[[1]]
73
-        }
59
+## select() interface:
60
+## Objects in this package can be accessed using the select() interface
61
+## from the AnnotationDbi package. See ?select for details.
62
+
63
+## Bimap interface:
64
+x <- @ANNOBJPREFIX@REFSEQ
65
+# Get the TAIR identifiers that are mapped to any RefSeq ID
66
+mapped_genes <- mappedkeys(x)
67
+# Convert to a list
68
+xx <- as.list(x[mapped_genes])
69
+if(length(xx) > 0) {
70
+  # Get the REFSEQ for the first five genes
71
+  xx[1:5]
72
+  # Get the first one
73
+  xx[[1]]
74
+}
75
+
76
+# For the reverse map:
77
+x <- @ANNOBJPREFIX@REFSEQ2TAIR
78
+# Get the RefSeq identifier that are mapped to an TAIR ID
79
+mapped_seqs <- mappedkeys(x)
80
+# Convert to a list
81
+xx <- as.list(x[mapped_seqs])
82
+if(length(xx) > 0) {
83
+  # Get the TAIR ID for the first five Refseqs
84
+  xx[1:5]
85
+  # Get the first one
86
+  xx[[1]]
87
+}
74 88
 }
75 89
 
76 90
 \keyword{datasets}
... ...
@@ -17,21 +17,35 @@
17 17
   Mappings were based on data provided by: @SYMBOLSOURCE@
18 18
   
19 19
 }
20
+
20 21
 \references{
21 22
   \url{http://www.ncbi.nlm.nih.gov/entrez/query.fcgi?db=gene}
22 23
 }
24
+
25
+\seealso{
26
+  \itemize{
27
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
28
+          the \code{select()} interface.
29
+  }
30
+}
31
+
23 32
 \examples{
24
-        x <- @ANNOBJPREFIX@SYMBOL
25
-        # Get the tair identifiers that are mapped to a gene symbol
26
-        mapped_genes <- mappedkeys(x)
27
-        # Convert to a list
28
-        xx <- as.list(x[mapped_genes])
29
-        if(length(xx) > 0) {
30
-          # Get the SYMBOL for the first five genes
31
-          xx[1:5]
32
-          # Get the first one
33
-          xx[[1]]
34
-        }
33
+## select() interface:
34
+## Objects in this package can be accessed using the select() interface
35
+## from the AnnotationDbi package. See ?select for details.
36
+
37
+## Bimap interface:
38
+x <- @ANNOBJPREFIX@SYMBOL
39
+# Get the tair identifiers that are mapped to a gene symbol
40
+mapped_genes <- mappedkeys(x)
41
+# Convert to a list
42
+xx <- as.list(x[mapped_genes])
43
+if(length(xx) > 0) {
44
+  # Get the SYMBOL for the first five genes
45
+  xx[1:5]
46
+  # Get the first one
47
+  xx[[1]]
48
+}
35 49
 }
36 50
 
37 51
 \keyword{datasets}
... ...
@@ -23,21 +23,30 @@
23 23
 }
24 24
 
25 25
 \seealso{
26
-  \code{\link[AnnotationDbi:Bimap-toTable]{nhit}}
26
+  \itemize{
27
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
28
+          the \code{select()} interface.
29
+    \item \code{\link[AnnotationDbi:Bimap-toTable]{nhit}}.
30
+  }
27 31
 }
28 32
 
29 33
 \examples{
30
-  x <- @ANNOBJPREFIX@ACCNUM
31
-  # Get the probe identifiers that are mapped to a chromosome
32
-  mapped_probes <- mappedkeys(x)
33
-  # Convert to a list
34
-  xx <- as.list(x[mapped_probes])
35
-  if(length(xx) > 0) {
36
-    # Get the AGI locus IDs for the first five probes
37
-    xx[1:5]
38
-    # Get the first one
39
-    xx[[1]]
40
-  }
34
+## select() interface:
35
+## Objects in this package can be accessed using the select() interface
36
+## from the AnnotationDbi package. See ?select for details.
37
+
38
+## Bimap interface:
39
+x <- @ANNOBJPREFIX@ACCNUM
40
+# Get the probe identifiers that are mapped to a chromosome
41
+mapped_probes <- mappedkeys(x)
42
+# Convert to a list
43
+xx <- as.list(x[mapped_probes])
44
+if(length(xx) > 0) {
45
+  # Get the AGI locus IDs for the first five probes
46
+  xx[1:5]
47
+  # Get the first one
48
+  xx[[1]]
49
+}
41 50
 
42 51
 ##   y <- @ANNOBJPREFIX@MULTIHIT
43 52
 ##  identical(keys(x), keys(y))    # TRUE
... ...
@@ -8,26 +8,40 @@
8 8
   by the probe identifiers are involved. Information is obtained from
9 9
   AraCyc.
10 10
 }
11
+
11 12
 \details{
12 13
   Annotation based on data provided by: @ARACYCSOURCE@
13 14
 }
15
+
14 16
 \references{
15 17
   \url{http://www.genome.ad.jp/kegg/}
16 18
 }
17 19
 
18
-\examples{
19
-  x <- @ANNOBJPREFIX@ARACYC
20
-  # Get the probe identifiers that are mapped to pathways
21
-  mapped_probes <- mappedkeys(x)
22
-  # Convert to a list
23
-  xx <- as.list(x[mapped_probes])
24
-  if(length(xx) > 0) {
25
-    # Get the pathways for the first five probes
26
-    xx[1:5]
27
-    # For the first probe
28
-    xx[[1]]
20
+\seealso{
21
+  \itemize{
22
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
23
+          the \code{select()} interface.
29 24
   }
30 25
 }
31 26
 
27
+\examples{
28
+## select() interface:
29
+## Objects in this package can be accessed using the select() interface
30
+## from the AnnotationDbi package. See ?select for details.
31
+
32
+## Bimap interface:
33
+x <- @ANNOBJPREFIX@ARACYC
34
+# Get the probe identifiers that are mapped to pathways
35
+mapped_probes <- mappedkeys(x)
36
+# Convert to a list
37
+xx <- as.list(x[mapped_probes])
38
+if(length(xx) > 0) {
39
+  # Get the pathways for the first five probes
40
+  xx[1:5]
41
+  # For the first probe
42
+  xx[[1]]
43
+}
44
+}
45
+
32 46
 \keyword{datasets}
33 47
 
... ...
@@ -10,21 +10,34 @@
10 10
   Enzyme name for that gene according to the ARACYC database.  If this
11 11
   information is unknown, the vector will contain an \code{NA}.
12 12
     
13
-  Mappings between probe identifiers and enzyme identifiers were obtained using files
14
-  provided by: @ENZYMESOURCE@
13
+  Mappings between probe identifiers and enzyme identifiers were obtained 
14
+  using files provided by: @ENZYMESOURCE@
15 15
 }
16
+
17
+\seealso{
18
+  \itemize{
19
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
20
+          the \code{select()} interface.
21
+  }
22
+}
23
+
16 24
 \examples{
17
-        x <- @ANNOBJPREFIX@ARACYCENZYME
18
-        # Get the probe identifiers that are mapped to an Enzyme Name 
19
-        mapped_probes <- mappedkeys(x)
20
-        # Convert to a list
21
-        xx <- as.list(x[mapped_probes])
22
-        if(length(xx) > 0) {
23
-          # Get the ENZYME name for the first five probes
24
-          xx[1:5]
25
-          # Get the first one
26
-          xx[[1]]
27
-        }
25
+## select() interface:
26
+## Objects in this package can be accessed using the select() interface 
27
+## from the AnnotationDbi package. See ?select for details.
28
+
29
+## Bimap interface:
30
+x <- @ANNOBJPREFIX@ARACYCENZYME
31
+# Get the probe identifiers that are mapped to an Enzyme Name 
32
+mapped_probes <- mappedkeys(x)
33
+# Convert to a list
34
+xx <- as.list(x[mapped_probes])
35
+if(length(xx) > 0) {
36
+  # Get the ENZYME name for the first five probes
37
+  xx[1:5]
38
+  # Get the first one
39
+  xx[[1]]
40
+}
28 41
 }
29 42
 \keyword{datasets}
30 43
 
... ...
@@ -3,19 +3,33 @@
3 3
 \alias{@ANNOBJPREFIX@}
4 4
 \title{Bioconductor annotation data package}
5 5
 \description{
6
-  
6
+ 
7 7
   Welcome to the @ANNOBJPREFIX@.db annotation Package.  The purpose of
8 8
   this package is to provide detailed information about the
9 9
   @ANNOBJPREFIX@ platform. This package is updated biannually.
10
-  
11
-  You can learn what objects this package supports with the following command:
10
+ 
11
+  Objects in this package are accessed using the \code{select()} interface.
12
+  See ?select in the AnnotationDbi package for details.
13
+}
12 14
 
13
-  \code{ls("package:@ANNOBJPREFIX@.db")} 
14
-  
15
-  Each of these objects has their own manual page detailing where
16
-  relevant data was obtained along with some examples of how to use it.
15
+\seealso{
16
+  \itemize{
17
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
18
+          \code{keys()}, \code{columns()} and \code{select()}.
19
+  }
17 20
 }
21
+
18 22
 \examples{
19
-  ls("package:@ANNOBJPREFIX@.db")
23
+## select() interface:
24
+## Objects in this package can be accessed using the select() interface
25
+## from the AnnotationDbi package. See ?select for details.
26
+columns(@ANNOBJPREFIX@.db)
27
+
28
+## Bimap interface:
29
+## The 'old style' of interacting with these objects is manipulation as 
30
+## bimaps. While this approach is still available we strongly encourage the
31
+## use of select().
32
+ls("package:@ANNOBJPREFIX@.db")
20 33
 }
34
+
21 35
 \keyword{datasets}
... ...
@@ -16,18 +16,31 @@
16 16
   
17 17
 }
18 18
 
19
+\seealso{
20
+  \itemize{
21
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
22
+          the \code{select()} interface.
23
+  }
24
+}
25
+
19 26
 \examples{
20
-        x <- @ANNOBJPREFIX@CHR
21
-        # Get the probe identifiers that are mapped to a chromosome
22
-        mapped_probes <- mappedkeys(x)
23
-        # Convert to a list
24
-        xx <- as.list(x[mapped_probes])
25
-        if(length(xx) > 0) {
26
-          # Get the CHR for the first five probes
27
-          xx[1:5]
28
-          # Get the first one
29
-          xx[[1]]
30
-        }
27
+## select() interface:
28
+## Objects in this package can be accessed using the select() interface
29
+## from the AnnotationDbi package. See ?select for details.
30
+
31
+## Bimap interface:
32
+x <- @ANNOBJPREFIX@CHR
33
+# Get the probe identifiers that are mapped to a chromosome
34
+mapped_probes <- mappedkeys(x)
35
+# Convert to a list
36
+xx <- as.list(x[mapped_probes])
37
+if(length(xx) > 0) {
38
+  # Get the CHR for the first five probes
39
+  xx[1:5]
40
+  # Get the first one
41
+  xx[[1]]
31 42
 }
43
+}
44
+
32 45
 \keyword{datasets}
33 46
 
... ...
@@ -13,10 +13,23 @@
13 13
    number of base pairs on the sequence string for each chromosome.
14 14
 
15 15
 }
16
+
17
+\seealso{
18
+  \itemize{
19
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
20
+          the \code{select()} interface.
21
+  }
22
+}
23
+
16 24
 \examples{
17
-    tt <- @ANNOBJPREFIX@CHRLENGTHS
18
-    # Length of chromosome 1
19
-    tt["1"]
25
+## select() interface:
26
+## Objects in this package can be accessed using the select() interface
27
+## from the AnnotationDbi package. See ?select for details.
28
+
29
+## Bimap interface:
30
+tt <- @ANNOBJPREFIX@CHRLENGTHS
31
+# Length of chromosome 1
32
+tt["1"]
20 33
 }
21 34
 \keyword{datasets}
22 35
 
... ...
@@ -10,6 +10,7 @@
10 10
   The CHRLOCEND mapping is the same as the CHRLOC mapping except that it
11 11
   specifies the ending base of a gene instead of the start.
12 12
 }
13
+
13 14
 \details{
14 15
   Each manufacturer identifier maps to a named vector of chromosomal locations,
15 16
   where the name indicates the chromosome. Due to inconsistencies that
... ...
@@ -25,18 +26,31 @@
25 26
   Mappings were based on data provided by: @CHRLOCSOURCE@
26 27
   
27 28
 }
29
+
30
+\seealso{
31
+  \itemize{
32
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
33
+          the \code{select()} interface.
34
+  }
35
+}
36
+
28 37
 \examples{
29
-        x <- @ANNOBJPREFIX@CHRLOC
30
-        # Get the probe identifiers that are mapped to chromosome locations
31
-        mapped_probes <- mappedkeys(x)
32
-        # Convert to a list
33
-        xx <- as.list(x[mapped_probes])
34
-        if(length(xx) > 0) {
35
-          # Get the CHRLOC for the first five probes
36
-          xx[1:5]
37
-          # Get the first one
38
-          xx[[1]]
39
-        }
38
+## select() interface:
39
+## Objects in this package can be accessed using the select() interface
40
+## from the AnnotationDbi package. See ?select for details.
41
+
42
+## Bimap interface:
43
+x <- @ANNOBJPREFIX@CHRLOC
44
+# Get the probe identifiers that are mapped to chromosome locations
45
+mapped_probes <- mappedkeys(x)
46
+# Convert to a list
47
+xx <- as.list(x[mapped_probes])
48
+if(length(xx) > 0) {
49
+  # Get the CHRLOC for the first five probes
50
+  xx[1:5]
51
+  # Get the first one
52
+  xx[[1]]
53
+}
40 54
 }
41 55
 \keyword{datasets}
42 56
 
... ...
@@ -47,18 +47,31 @@
47 47
 \references{
48 48
 \url{ftp://ftp.genome.ad.jp/pub/kegg/pathways}
49 49
 }
50
+
51
+\seealso{
52
+  \itemize{
53
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
54
+          the \code{select()} interface.
55
+  }
56
+}
57
+
50 58
 \examples{
51
-        x <- @ANNOBJPREFIX@ENZYME
52
-        # Get the probe identifiers that are mapped to an EC number 
53
-        mapped_probes <- mappedkeys(x)
54
-        # Convert to a list
55
-        xx <- as.list(x[mapped_probes])
56
-        if(length(xx) > 0) {
57
-          # Get the ENZYME for the first five probes
58
-          xx[1:5]
59
-          # Get the first one
60
-          xx[[1]]
61
-        }
59
+## select() interface:
60
+## Objects in this package can be accessed using the select() interface
61
+## from the AnnotationDbi package. See ?select for details.
62
+
63
+## Bimap interface:
64
+x <- @ANNOBJPREFIX@ENZYME
65
+# Get the probe identifiers that are mapped to an EC number 
66
+mapped_probes <- mappedkeys(x)
67
+# Convert to a list
68
+xx <- as.list(x[mapped_probes])
69
+if(length(xx) > 0) {
70
+  # Get the ENZYME for the first five probes
71
+  xx[1:5]
72
+  # Get the first one
73
+  xx[[1]]
74
+}
62 75
 }
63 76
 \keyword{datasets}
64 77
 
... ...
@@ -45,16 +45,29 @@
45 45
 \references{
46 46
 \url{ftp://ftp.genome.ad.jp/pub/kegg/pathways}
47 47
 }
48
+
49
+\seealso{
50
+  \itemize{
51
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
52
+          the \code{select()} interface.
53
+  }
54
+}
55
+
48 56
 \examples{
49
-    # Convert to a list
50
-    xx <- as.list(@ANNOBJPREFIX@ENZYME2PROBE)
51
-   if(length(xx) > 0){
52
-       # Gets the probe identifiers for the first five enzyme
53
-       #commission numbers
54
-       xx[1:5]
55
-       # Get the first one
56
-       xx[[1]]
57
-    }
57
+## select() interface:
58
+## Objects in this package can be accessed using the select() interface
59
+## from the AnnotationDbi package. See ?select for details.
60
+
61
+## Bimap interface:
62
+# Convert to a list
63
+xx <- as.list(@ANNOBJPREFIX@ENZYME2PROBE)
64
+if(length(xx) > 0){
65
+    # Gets the probe identifiers for the first five enzyme
66
+    #commission numbers
67
+    xx[1:5]
68
+    # Get the first one
69
+    xx[[1]]
70
+}
58 71
 }
59 72
 \keyword{datasets}
60 73
 
... ...
@@ -19,18 +19,30 @@
19 19
   
20 20
 }
21 21
 
22
+\seealso{
23
+  \itemize{
24
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
25
+          the \code{select()} interface.
26
+  }
27
+}
28
+
22 29
 \examples{
23
-        x <- @ANNOBJPREFIX@GENENAME
24
-        # Get the probe identifiers that are mapped to a gene name
25
-        mapped_probes <- mappedkeys(x)
26
-        # Convert to a list
27
-        xx <- as.list(x[mapped_probes])
28
-        if(length(xx) > 0) {
29
-          # Get the GENENAME for the first five probes
30
-          xx[1:5]
31
-          # Get the first one
32
-          xx[[1]]
33
-        }
30
+## select() interface:
31
+## Objects in this package can be accessed using the select() interface
32
+## from the AnnotationDbi package. See ?select for details.
33
+
34
+## Bimap interface:
35
+x <- @ANNOBJPREFIX@GENENAME
36
+# Get the probe identifiers that are mapped to a gene name
37
+mapped_probes <- mappedkeys(x)
38
+# Convert to a list
39
+xx <- as.list(x[mapped_probes])
40
+if(length(xx) > 0) {
41
+  # Get the GENENAME for the first five probes
42
+  xx[1:5]
43
+  # Get the first one
44
+  xx[[1]]
45
+}
34 46
 }
35 47
 \keyword{datasets}
36 48
 
... ...
@@ -60,20 +60,32 @@
60 60
 
61 61
 }
62 62
 
63
+\seealso{
64
+  \itemize{
65
+    \item \code{\link[AnnotationDbi]{AnnotationDb-class}} for use of
66
+          the \code{select()} interface.
67
+  }
68
+}
69
+
63 70
 \examples{
64
-        x <- @ANNOBJPREFIX@GO
65
-        # Get the probe identifiers that are mapped to a GO ID
66
-        mapped_probes <- mappedkeys(x)
67
-        # Convert to a list
68
-        xx <- as.list(x[mapped_probes])
69
-        if(length(xx) > 0) {
70
-            # Try the firest one
71
-            got <- xx[[1]]           
72
-            got[[1]][["GOID"]]
73
-            got[[1]][["Ontology"]]
74
-            got[[1]][["Evidence"]]
75
-
76
-        }
71
+## select() interface:
72
+## Objects in this package can be accessed using the select() interface
73
+## from the AnnotationDbi package. See ?select for details.
74
+
75
+## Bimap interface:
76
+x <- @ANNOBJPREFIX@GO
77
+# Get the probe identifiers that are mapped to a GO ID
78
+mapped_probes <- mappedkeys(x)
79
+# Convert to a list
80
+xx <- as.list(x[mapped_probes])
81