export names.CELL_META

NAMESPACE

@@ -1,5 +1,7 @@
 S3method("$", "CELL_META")
 export("$.CELL_META")
+S3method("names", "CELL_META")
+export("names.CELL_META")
 S3method("print", "CELL_META")
 export("print.CELL_META")
 export("CELL_META")

R/global.R

@@ -793,7 +793,7 @@ get.cell.meta.data = function(name, sector.index = get.current.sector.index(),
 }
 
 # == title (variable:CELL_META)
-# Easy to way to get meta data in the current cell
+# Easy way to get meta data in the current cell
 #
 # == details
 # The variable `CELL_META` can only be used to get meta data of the "current" cell.
@@ -812,6 +812,15 @@ get.cell.meta.data = function(name, sector.index = get.current.sector.index(),
 # dev.off()
 CELL_META = "don't use me directly"
 class(CELL_META) = "CELL_META"
+
+# == title 
+# Names of all meta data in the current cell
+#
+# == param
+# -x use `CELL_META`.
+#
+# == example
+# names(CELL_META)
 names.CELL_META = function(x) {
 	c("xlim", "ylim", "xrange", "yrange", "xcenter", "ycenter", "cell.xlim", "cell.ylim",
      "sector.numeric.index", "sector.index", "track.index", "xplot", "yplot", "track.margin", "cell.padding",

man/CELL_META.rd

@@ -2,10 +2,10 @@
 \docType{data}
 \alias{CELL_META}
 \title{
-Easy to way to get meta data in the current cell
+Easy way to get meta data in the current cell
 }
 \description{
-Easy to way to get meta data in the current cell
+Easy way to get meta data in the current cell
 }
 \usage{
 CELL_META

man/names.CELL_META.rd

@@ -0,0 +1,28 @@
+\name{names.CELL_META}
+\alias{names.CELL_META}
+\title{
+Names of all meta data in the current cell
+}
+\description{
+Names of all meta data in the current cell
+}
+\usage{
+\method{names}{CELL_META}(x)
+}
+\arguments{
+
+  \item{x}{use \code{\link{CELL_META}}.}
+
+}
+\details{
+The variable \code{\link{CELL_META}} can only be used to get meta data of the "current" cell.
+Basically you can simply replace  e.g. \code{get.cell.meta.data("sector.index")} to \code{CELL_META$sector.index}.
+
+}
+\seealso{
+\code{\link{get.cell.meta.data}}
+
+}
+\examples{
+names(CELL_META)
+}