[H5r-commits] r56 - man

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

Author: malinka
Date: 2011-07-20 02:02:38 +0200 (Wed, 20 Jul 2011)
New Revision: 56

Added:
   man/createH5Group.Rd
Modified:
   man/createH5Attribute.Rd
   man/createH5Dataset.Rd
Log:
Adding help page for createH5Group.Rd


Modified: man/createH5Attribute.Rd
===================================================================
--- man/createH5Attribute.Rd	2011-07-19 22:24:05 UTC (rev 55)
+++ man/createH5Attribute.Rd	2011-07-20 00:02:38 UTC (rev 56)
@@ -4,20 +4,20 @@
   This is a Metadata Oject that Describes the Primary Data Object
 }
 \description{
- The attribute describes characteristics of the primary data object,
- such as a dataset, and specifies the attribute property list. The
- primary data object characteristics include the datatype and
- dataspace of the attribute data.
+  The attribute describes characteristics of the primary data object,
+  such as a dataset, and specifies the attribute property list. The
+  primary data object characteristics include the datatype and
+  dataspace of the attribute data.
 }
 \usage{
-createH5Attribute(h5Obj, attrName, attrValue, ...)
+  createH5Attribute(h5Obj, attrName, attrValue, ...)
 }
 \arguments{
   \item{h5Obj}{
     Oject to which the attribute is attached.
 }
   \item{attrName}{
-    Name of attribute
+    Name of attribute.
 }
   \item{attrValue}{
     The value portion of the attribute which contains data element(s)
@@ -29,7 +29,7 @@
 }
 \details{
   The attribute is attached to an object and has a unique name. The
-  value part of the attribute conatins one or more data elements
+  value part of the attribute conatins one or more data elements.
 }
 \value{
   This function returns the class of attribute, name, dimensions and
@@ -44,5 +44,5 @@
   createH5Attribute(h5, "attri", c("a","b","c","d"))
   createH5Attribute(h5, "bute", as.integer(c(rnorm(1),rpois(1,5))))
 }
-\keyword{dataset}
+\keyword{attribute}
 

Modified: man/createH5Dataset.Rd
===================================================================
--- man/createH5Dataset.Rd	2011-07-19 22:24:05 UTC (rev 55)
+++ man/createH5Dataset.Rd	2011-07-20 00:02:38 UTC (rev 56)
@@ -62,5 +62,5 @@
       writeH5Data(m, as.integer(rpois(1000,lambda = 10)), c((i-1)*1000+1,1),c( 1000,1))
   }
 }
-\keyword{dataset}
+\keyword{programming}
 

Added: man/createH5Group.Rd
===================================================================
--- man/createH5Group.Rd	                        (rev 0)
+++ man/createH5Group.Rd	2011-07-20 00:02:38 UTC (rev 56)
@@ -0,0 +1,45 @@
+\name{createH5Group}
+\alias{createH5Group}
+\title{
+   Fill in
+}
+\description{
+  Fill in
+}
+\usage{
+createH5Group(h5Obj, groupName, ...)
+}
+\arguments{
+  \item{h5Obj}{
+  Fill in
+}
+  \item{groupName}{
+  Describe this
+}
+  \item{\dots}{
+  Describe this
+}
+}
+\details{
+ more here
+}
+\value{
+  Describe the value returned
+  If it is a LIST, use
+  \item{comp1 }{Description of 'comp1'}
+  \item{comp2 }{Description of 'comp2'}
+}
+\references{
+  Blah 
+}
+\note{
+  Further notes
+}
+\seealso{
+  Helpful link
+}
+\examples{
+  Example here
+}
+\keyword{key}
+