[H5r-commits] r62 - man

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

Author: malinka
Date: 2011-08-04 02:18:32 +0200 (Thu, 04 Aug 2011)
New Revision: 62

Added:
   man/readPoints.Rd
Log:
added documentation for the h5r function "readPoints"


Added: man/readPoints.Rd
===================================================================
--- man/readPoints.Rd	                        (rev 0)
+++ man/readPoints.Rd	2011-08-04 00:18:32 UTC (rev 62)
@@ -0,0 +1,37 @@
+\name{readPoints}
+\alias{readPoints}
+\title{
+  Prints Specified Data Points from the Selected H5 Dataset
+}
+\description{
+  'readPoints' is a function that prints user-specified points from an
+  H5 dataset. These points may be selected either by directly specifying
+  coordinate indexes, or by a sampling function.
+}
+\usage{
+readPoints(h5Dataset, idxs)
+}
+\arguments{
+  \item{h5Dataset}{
+  Specify H5 dataset.
+}
+  \item{idxs}{
+  Specify coordinate indexes to be printed.
+}
+\value{
+  The values returned depend on H5 dataset data. Values returned can be
+  of type integer, double or character.
+}
+\seealso{
+  \link{read1DSlabs}
+}
+\examples{
+  require(h5r)
+  h5 <- H5File("test.h5", 'w')
+  d1 <- createH5Dataset(h5, "jon", runif(100000))
+  p <- readPoints(d1, ss <- sample(1:length(d1), size = 1000, replace = T))
+  head(p)
+  all(p == d1[ss])
+}
+\keyword{datasets}
+