[H5r-commits] r55 - man

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

Author: malinka
Date: 2011-07-20 00:24:05 +0200 (Wed, 20 Jul 2011)
New Revision: 55

Modified:
   man/createH5Attribute.Rd
Log:
Modified the help file for the createH5Attribute function.


Modified: man/createH5Attribute.Rd
===================================================================
--- man/createH5Attribute.Rd	2011-07-19 17:35:30 UTC (rev 54)
+++ man/createH5Attribute.Rd	2011-07-19 22:24:05 UTC (rev 55)
@@ -1,38 +1,48 @@
 \name{createH5Attribute}
 \alias{createH5Attribute}
-\title{ fille me
+\title{
+  This is a Metadata Oject that Describes the Primary Data Object
 }
 \description{
-fill me
+ 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, ...)
 }
 \arguments{
   \item{h5Obj}{
-  Oject in which attribute is located.
+    Oject to which the attribute is attached.
 }
   \item{attrName}{
     Name of attribute
 }
   \item{attrValue}{
-  Actual data values
+    The value portion of the attribute which contains data element(s)
+    of the same data type. 
 }
-  \item{\dots}{
-    extra arguments
+   \item{\dots}{
+     Extra arguments. See class documentation for specific methods.
 }
 }
 \details{
-  fill me
+  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{
-  return values of the function ... 
+  This function returns the class of attribute, name, dimensions and
+  data type.
 }
 \seealso{
   readH5Attribute
 }
 \examples{
-2 + 2
+  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))))
 }
 \keyword{dataset}