[H5r-commits] r57 - man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Thu Jul 21 01:55:29 CEST 2011
Author: malinka
Date: 2011-07-21 01:55:29 +0200 (Thu, 21 Jul 2011)
New Revision: 57
Added:
man/deleteH5Attribute.Rd
man/deleteH5Obj.Rd
man/h5AttributeExists.Rd
Modified:
man/createH5Attribute.Rd
man/createH5Dataset.Rd
man/createH5Group.Rd
Log:
Adding three help files...
Modified: man/createH5Attribute.Rd
===================================================================
--- man/createH5Attribute.Rd 2011-07-20 00:02:38 UTC (rev 56)
+++ man/createH5Attribute.Rd 2011-07-20 23:55:29 UTC (rev 57)
@@ -1,10 +1,10 @@
\name{createH5Attribute}
\alias{createH5Attribute}
\title{
- This is a Metadata Oject that Describes the Primary Data Object
+ A Function that Creates a Metadata Oject that Describes the Primary Data Object
}
\description{
- The attribute describes characteristics of the primary data object,
+ 'createH5Attribute' 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.
@@ -32,12 +32,8 @@
value part of the attribute conatins one or more data elements.
}
\value{
- This function returns the class of attribute, name, dimensions and
- data type.
+ An object of type H5Attribute.
}
-\seealso{
- readH5Attribute
-}
\examples{
require(h5r)
h5 <- H5File("test.h5", 'w')
Modified: man/createH5Dataset.Rd
===================================================================
--- man/createH5Dataset.Rd 2011-07-20 00:02:38 UTC (rev 56)
+++ man/createH5Dataset.Rd 2011-07-20 23:55:29 UTC (rev 57)
@@ -2,9 +2,11 @@
\alias{createH5Dataset}
\alias{writeH5Data}
-\title{Create a dataset in the specified H5 object.}
+\title{Create a Dataset in the Specified H5 Object}
\description{
- Create a dataset by name in the specified H5 object.
+ 'createH5Dataset' contains a header and a data
+ array. The header describes the name of the group, datatype,
+ dataspace, and storage layout.
}
\usage{
createH5Dataset(h5Obj, datasetName, data, dims, dType =
@@ -62,5 +64,5 @@
writeH5Data(m, as.integer(rpois(1000,lambda = 10)), c((i-1)*1000+1,1),c( 1000,1))
}
}
-\keyword{programming}
+\keyword{datasets}
Modified: man/createH5Group.Rd
===================================================================
--- man/createH5Group.Rd 2011-07-20 00:02:38 UTC (rev 56)
+++ man/createH5Group.Rd 2011-07-20 23:55:29 UTC (rev 57)
@@ -1,45 +1,42 @@
\name{createH5Group}
\alias{createH5Group}
\title{
- Fill in
+ Create a Group that Contains HDF5 Objects
}
\description{
- Fill in
+ 'createH5Group' contains zero or more HDF5 objects which can consist of
+ either groups, or datasets, and supporting metadata.
}
\usage{
-createH5Group(h5Obj, groupName, ...)
+ createH5Group(h5Obj, groupName, ...)
}
\arguments{
\item{h5Obj}{
- Fill in
+ H5 object in which the group(s) or dataset(s) are located.
}
\item{groupName}{
- Describe this
+ Name of group.
}
\item{\dots}{
- Describe this
+ Extra arguments. See class documentation for specific methods.
}
}
\details{
- more here
+ HDF5 groups are comparable to directories in Linux/Unix.
}
\value{
- Describe the value returned
- If it is a LIST, use
- \item{comp1 }{Description of 'comp1'}
- \item{comp2 }{Description of 'comp2'}
+ An object of type H5Group.
}
\references{
- Blah
+ \url{http://www.hdfgroup.org/HDF5/doc/H5.intro.html.#IntroOGroups}
}
-\note{
- Further notes
-}
\seealso{
- Helpful link
+ \link[=HDF5 file structures]{createH5Datasets}
}
\examples{
- Example here
+ library("h5r")
+ h5 <- H5File("test.H5",'w')
+ createH5Group(h5, "grp101")
}
-\keyword{key}
+\keyword{datasets}
Added: man/deleteH5Attribute.Rd
===================================================================
--- man/deleteH5Attribute.Rd (rev 0)
+++ man/deleteH5Attribute.Rd 2011-07-20 23:55:29 UTC (rev 57)
@@ -0,0 +1,51 @@
+\name{deleteH5Attribute}
+\alias{deleteH5Attribute}
+\alias{createH5Attribute}
+\title{
+ A Function that Deletes a Metadata Object which Describes the Primary
+ Data Object
+}
+\description{
+ 'deleteH5Attribute' removes the attribute that describes
+ characteristics of the primary data object.
+}
+\usage{
+ deleteH5Attribute(h5Obj, attrName, ...)
+}
+\arguments{
+ \item{h5Obj}{
+ Oject to which the attribute is attached.
+}
+ \item{attrName}{
+ Name of attribute.
+}
+ \item{attrValue}{
+ The value portion of the attribute which contains data element(s)
+ of the same data type.
+}
+ \item{\dots}{
+ Extra arguments. See class documentation for specific methods.
+}
+}
+\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{
+ An object of type H5Attribute.
+}
+\seealso{
+ \link[=attribute]{createH5Attribute}
+}
+\examples{
+ require(h5r)
+ h5 <- H5File("test.h5", 'w')
+
+ atr <- createH5Attribute(h5, "atr1", 10:1)
+ atr
+
+ dl <- deleteH5Attribute(h5, "atr1")
+ dl
+}
+\keyword{datasets}
+
Added: man/deleteH5Obj.Rd
===================================================================
--- man/deleteH5Obj.Rd (rev 0)
+++ man/deleteH5Obj.Rd 2011-07-20 23:55:29 UTC (rev 57)
@@ -0,0 +1,42 @@
+\name{deleteH5Obj}
+\alias{deleteH5Obj}
+\title{
+ Delete H5Object
+}
+\description{
+ 'deleteH5Obj' is a function that removes the H5 Object. The H5 object,
+ which is a baseclass, contains three subclasses: group, dataset and
+ datatype.
+}
+\usage{
+deleteH5Obj(h5Obj, h5ObjName, ...)
+}
+\arguments{
+ \item{h5Obj}{
+ This is the H5Object itself.
+}
+ \item{h5ObjName}{
+ Name of H5Object.
+}
+ \item{\dots}{
+ Extra arguments. See class documentation for specific methods.
+}
+}
+\value{
+ An object of type H5Object.
+}
+\references{
+ \link{http://www.hdfgroup.org/HDF5/doc/cpplus_RM/classH5_1_1H5Object.html}
+}
+\seealso{
+ \link[=HDF5 groups]{createH5Group}
+}
+\examples{
+ require(h5r)
+ h5 <- H5File("test.h5", 'w')
+ g1 <- createH5Group(h5,"grp1")
+ dl <- deleteH5Obj(h5,"grp1")
+ dl
+}
+\keyword{data}
+
Added: man/h5AttributeExists.Rd
===================================================================
--- man/h5AttributeExists.Rd (rev 0)
+++ man/h5AttributeExists.Rd 2011-07-20 23:55:29 UTC (rev 57)
@@ -0,0 +1,61 @@
+\name{h5AttributeExists}
+\alias{h5AttributeExists}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{
+%% ~~function to do ... ~~
+}
+\description{
+%% ~~ A concise (1-5 lines) description of what the function does. ~~
+}
+\usage{
+h5AttributeExists(h5Obj, name)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{h5Obj}{
+%% ~~Describe \code{h5Obj} here~~
+}
+ \item{name}{
+%% ~~Describe \code{name} here~~
+}
+}
+\details{
+%% ~~ If necessary, more details than the description above ~~
+}
+\value{
+%% ~Describe the value returned
+%% If it is a LIST, use
+%% \item{comp1 }{Description of 'comp1'}
+%% \item{comp2 }{Description of 'comp2'}
+%% ...
+}
+\references{
+%% ~put references to the literature/web site here ~
+}
+\author{
+%% ~~who you are~~
+}
+\note{
+%% ~~further notes~~
+}
+
+%% ~Make other sections like Warning with \section{Warning }{....} ~
+
+\seealso{
+%% ~~objects to See Also as \code{\link{help}}, ~~~
+}
+\examples{
+##---- Should be DIRECTLY executable !! ----
+##-- ==> Define data, use random,
+##-- or do help(data=index) for the standard data sets.
+
+## The function is currently defined as
+function (h5Obj, name)
+{
+ .myCall("h5R_attribute_exists", .ePtr(h5Obj), name)
+ }
+}
+% Add one or more standard keywords, see file 'KEYWORDS' in the
+% R documentation directory.
+\keyword{ ~kwd1 }
+\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
More information about the H5r-commits
mailing list