[H5r-commits] r59 - man

[noreply at r-forge.r-project.org]

Author: malinka
Date: 2011-07-22 19:31:34 +0200 (Fri, 22 Jul 2011)
New Revision: 59

Modified:
   man/H5DataFrame.Rd
   man/createH5Attribute.Rd
   man/createH5Dataset.Rd
   man/h5AttributeExists.Rd
   man/h5DatasetExists.Rd
   man/h5GroupExists.Rd
   man/h5ObjectExists.Rd
   man/listH5Attributes.Rd
Log:


Modified: man/H5DataFrame.Rd
===================================================================
--- man/H5DataFrame.Rd	2011-07-22 16:34:02 UTC (rev 58)
+++ man/H5DataFrame.Rd	2011-07-22 17:31:34 UTC (rev 59)
@@ -1,5 +1,6 @@
 \name{H5DataFrame}
 \alias{H5DataFrame}
+\alias{writeH5DataFrame}
 \title{
   Create an H5 Data Frame
 }
@@ -12,48 +13,26 @@
 }
 \arguments{
   \item{file}{
-    
+    H5 file.
 }
   \item{nms}{
-%%     ~~Describe \code{nms} here~~
+    File names.
 }
 }
 \details{
-%%  ~~ If necessary, more details than the description above ~~
 }
 \value{
-%%  ~Describe the value returned
-%%  If it is a LIST, use
-%%  \item{comp1 }{Description of 'comp1'}
-%%  \item{comp2 }{Description of 'comp2'}
-%% ...
 }
 \references{
-%% ~put references to the literature/web site here ~
 }
-\author{
-%%  ~~who you are~~
-}
 \note{
-%%  ~~further notes~~
 }
-
-%% ~Make other sections like Warning with \section{Warning }{....} ~
-
 \seealso{
-%% ~~objects to See Also as \code{\link{help}}, ~~~
 }
 \examples{
    require(h5r)
    h5 <- H5File("test.h5", 'w')
-   d1 <- createH5Dataset(h5,"one", c(1,7,5))
-   d2 <- createH5Dataset(h5,"two", c(6,4,8))
-   ...
-
-##---- Should be DIRECTLY executable !! ----
-##-- ==>  Define data, use random,
-##--	or do  help(data=index)  for the standard data sets.
-
+...
 ## The function is currently defined as
 function (file, nms = NA) 
 {
@@ -76,7 +55,5 @@
     return(obj)
   }
 }
-% Add one or more standard keywords, see file 'KEYWORDS' in the
-% R documentation directory.
-\keyword{ ~kwd1 }
-\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
+\keyword{datagen}
+

Modified: man/createH5Attribute.Rd
===================================================================
--- man/createH5Attribute.Rd	2011-07-22 16:34:02 UTC (rev 58)
+++ man/createH5Attribute.Rd	2011-07-22 17:31:34 UTC (rev 59)
@@ -37,8 +37,9 @@
 \examples{
   require(h5r)
   h5 <- H5File("test.h5", 'w')
-  createH5Attribute(h5, "attri", c("a","b","c","d"))
-  createH5Attribute(h5, "bute", as.integer(c(rnorm(1),rpois(1,5))))
+  a <-  createH5Attribute(h5, "attri", c("a","b","c","d"))
+  b <-  createH5Attribute(h5, "bute", as.integer(c(rnorm(1),rpois(1,5))))
+  list(a,b)
 }
 \keyword{attribute}
 

Modified: man/createH5Dataset.Rd
===================================================================
--- man/createH5Dataset.Rd	2011-07-22 16:34:02 UTC (rev 58)
+++ man/createH5Dataset.Rd	2011-07-22 17:31:34 UTC (rev 59)
@@ -36,10 +36,10 @@
     
   }
   \item{offsets} {
-    Determines x,y-point at which vector or matrix begins.
+    Determines x,y-point at which vector begins.
   }
   \item{extents} {
-    Determines the length of the vector or matrix.
+    Determines the length of the vector.
     }
 }
 \value{

Modified: man/h5AttributeExists.Rd
===================================================================
--- man/h5AttributeExists.Rd	2011-07-22 16:34:02 UTC (rev 58)
+++ man/h5AttributeExists.Rd	2011-07-22 17:31:34 UTC (rev 59)
@@ -20,7 +20,7 @@
 }
 }
 \value{
-  The object returned is of type character.
+  The object returned is of type logical.
 }
 \seealso{
   \link{createH5Attribute}

Modified: man/h5DatasetExists.Rd
===================================================================
--- man/h5DatasetExists.Rd	2011-07-22 16:34:02 UTC (rev 58)
+++ man/h5DatasetExists.Rd	2011-07-22 17:31:34 UTC (rev 59)
@@ -19,7 +19,7 @@
 }
 }
 \value{
-  The object returned is of type character.
+  The object returned is of type logical.
 }
 \seealso{
   \link{createH5Dataset}

Modified: man/h5GroupExists.Rd
===================================================================
--- man/h5GroupExists.Rd	2011-07-22 16:34:02 UTC (rev 58)
+++ man/h5GroupExists.Rd	2011-07-22 17:31:34 UTC (rev 59)
@@ -20,7 +20,7 @@
 }
 }
 \value{
-  The object returned is of type character.
+  The object returned is of type logical.
 }
 \seealso{
   \link{createH5Group}

Modified: man/h5ObjectExists.Rd
===================================================================
--- man/h5ObjectExists.Rd	2011-07-22 16:34:02 UTC (rev 58)
+++ man/h5ObjectExists.Rd	2011-07-22 17:31:34 UTC (rev 59)
@@ -19,7 +19,7 @@
 }
 }
 \value{
-  The object returned is of type character.
+  The object returned is of type logical.
 }
 \seealso{
   \link{createH5Dataset}

Modified: man/listH5Attributes.Rd
===================================================================
--- man/listH5Attributes.Rd	2011-07-22 16:34:02 UTC (rev 58)
+++ man/listH5Attributes.Rd	2011-07-22 17:31:34 UTC (rev 59)
@@ -23,8 +23,7 @@
 \examples{
   require(h5r)
   h5 <- H5File("test.h5", 'w')
-  createH5Attribute(h5, "attri", c("a","b","c","d"))
-  createH5Attribute(h5, "bute", as.integer(c(rnorm(1),rpois(1,5))))
+  listH5Attributes(h5)
 }
 \keyword{attribute}