[H5r-commits] r54 - man

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

Author: malinka
Date: 2011-07-19 19:35:30 +0200 (Tue, 19 Jul 2011)
New Revision: 54

Added:
   man/createH5Attribute.Rd
   man/createH5Dataset.Rd
Removed:
   man/readDataAsVector.Rd
Log:
Added two help pages...


Added: man/createH5Attribute.Rd
===================================================================
--- man/createH5Attribute.Rd	                        (rev 0)
+++ man/createH5Attribute.Rd	2011-07-19 17:35:30 UTC (rev 54)
@@ -0,0 +1,38 @@
+\name{createH5Attribute}
+\alias{createH5Attribute}
+\title{ fille me
+}
+\description{
+fill me
+}
+\usage{
+createH5Attribute(h5Obj, attrName, attrValue, ...)
+}
+\arguments{
+  \item{h5Obj}{
+  Oject in which attribute is located.
+}
+  \item{attrName}{
+    Name of attribute
+}
+  \item{attrValue}{
+  Actual data values
+}
+  \item{\dots}{
+    extra arguments
+}
+}
+\details{
+  fill me
+}
+\value{
+  return values of the function ... 
+}
+\seealso{
+  readH5Attribute
+}
+\examples{
+2 + 2
+}
+\keyword{dataset}
+

Added: man/createH5Dataset.Rd
===================================================================
--- man/createH5Dataset.Rd	                        (rev 0)
+++ man/createH5Dataset.Rd	2011-07-19 17:35:30 UTC (rev 54)
@@ -0,0 +1,66 @@
+\name{createH5Dataset}
+\alias{createH5Dataset}
+\alias{writeH5Data}
+
+\title{Create a dataset in the specified H5 object.}
+\description{
+  Create a dataset by name in the specified H5 object.
+}
+\usage{
+  createH5Dataset(h5Obj, datasetName, data, dims, dType =
+  c("integer", "double", "character"), chunkSizes = NA, overwrite = TRUE)
+}
+\arguments{
+  \item{h5Obj}{
+    H5 object in which the dataset is located.
+  }
+  \item{datasetName}{
+    Specify name of dataset.
+  }
+  \item{data} {
+    The actual data to store, e.g., a matrix or vector of the same data type.
+  }
+  \item{dims}{
+    Specify dimensions of dataset.
+  }
+  \item{dType}{
+    Specify data type; integer, double or character.
+  }
+  \item{chunkSizes} {
+    Specify chunk sizes of dataset.
+  }
+  \item{overwrite} {
+    Overwrite dataset.
+    
+  }
+  \item{offsets} {
+    Determines x,y-point at which vector or matrix begins.
+  }
+  \item{extents} {
+    Determines the length of the vector or matrix.
+    }
+}
+\value{
+  Values returned are integer, double or character, depending on
+  data type.
+}
+\examples{
+  library("h5r")
+  h5 <- H5File("test.H5",'w')
+  m <- createH5Dataset(h5, "mm", cbind(rnorm(1000), rnorm(1000)))
+  m[1:10, 2]
+
+  m <- createH5Dataset(h5, "nn", dims = c(2,2),dType = "character")
+  m[]
+  writeH5Data(m, c("agct", "tcga"), c(1,1), c(1,2)) 
+  writeH5Data(m, c("jack", "jill"), c(2,1), c(1,2)) 
+  m[]
+  ls(h5)
+  m <- createH5Dataset(h5, "vect", dims = c(10000,1), dType = "integer")
+  m[]
+  for(i in 1:10) {
+      writeH5Data(m, as.integer(rpois(1000,lambda = 10)), c((i-1)*1000+1,1),c( 1000,1))
+  }
+}
+\keyword{dataset}
+

Deleted: man/readDataAsVector.Rd
===================================================================
--- man/readDataAsVector.Rd	2011-07-01 17:36:51 UTC (rev 53)
+++ man/readDataAsVector.Rd	2011-07-19 17:35:30 UTC (rev 54)
@@ -1,26 +0,0 @@
-\name{readDataAsVector}
-\alias{readDataAsVector}
-\alias{readDataAsVector,H5Dataset-method}
-\alias{readDataAsVector,H5Attribute-method}
-\title{
-  Reads the data from a dataset as a vector with no dimensions. Useful
-  internally as well as the case when one wants to shape differently. 
-}
-\description{
-  This function returns a vector of the same type as the dataset with
-  length: \code{"prod(dim(h5Dataset))"}.
-}
-\usage{
-readDataAsVector(h5Obj, ...)
-}
-\arguments{
-  \item{h5Obj}{Either a H5Dataset or H5Attribute.}
-  \item{...}{Standard generic definition.}
-}
-\examples{
- f <- system.file("h5_files", "ex_1.h5", package = "h5r")
- h5 <- H5File(f)
- d <- getH5Dataset(getH5Group(h5, "group_1"), "ds_1")
- head(readDataAsVector(d))
-}
-\keyword{file}