[H5r-commits] r61 - man

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

Author: malinka
Date: 2011-08-04 01:09:40 +0200 (Thu, 04 Aug 2011)
New Revision: 61

Added:
   man/readH5Data.Rd
Log:
added documentation for h5r function readH5Data


Added: man/readH5Data.Rd
===================================================================
--- man/readH5Data.Rd	                        (rev 0)
+++ man/readH5Data.Rd	2011-08-03 23:09:40 UTC (rev 61)
@@ -0,0 +1,32 @@
+\name{readH5Data}
+\alias{readH5Data}
+\title{
+  Print H5 data in the specified H5 Object
+}
+\description{
+  'readH5Data' is a function that is used for printing out a dataset in
+  the specified H5 Object.
+}
+\usage{
+readH5Data(h5Obj, ...)
+}
+\arguments{
+  \item{h5Obj}{
+    H5 object in which the dataset is located.
+}
+  \item{\dots}{
+    Extra arguments. See class documentation for specific methods.
+}
+}
+\value{
+  The values returned depend on H5 dataset data. Values returned can be
+  of type integer, double or character.
+}
+\examples{
+  require(h5r)
+  h5 <- H5File("test.H5",'w')
+  m <- createH5Dataset(h5, "mm", cbind(rnorm(1000), rnorm(1000)))
+  readH5Data(m)
+}
+\keyword{datasets}
+