1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/h5modifier.R
\name{h5_set_extent}
\alias{h5_set_extent}
\alias{h5set_extent}
\title{Set a new dataset extension}
\usage{
h5set_extent(file, dataset, dims, native = FALSE)
}
\arguments{
\item{file}{The filename (character) of the file in which the dataset will
be located. For advanced programmers it is possible to provide an object of
class \linkS4class{H5IdComponent} representing a H5 location identifier
(file or group). See \code{\link{H5Fcreate}}, \code{\link{H5Fopen}},
\code{\link{H5Gcreate}}, \code{\link{H5Gopen}} to create an object of this
kind.}
\item{dataset}{The name of the dataset in the HDF5 file, or an object of
class \linkS4class{H5IdComponent} representing a H5 dataset identifier. See
\code{\link{H5Dcreate}}, or \code{\link{H5Dopen}} to create an object of
this kind.}
\item{dims}{The dimensions of the array as they will appear in the file.
Note, the dimensions will appear in inverted order when viewing the file
with a C program (e.g. HDFView), because the fastest changing dimension in
R is the first one, whereas the fastest changing dimension in C is the last
one.}
\item{native}{An object of class \code{logical}. If \code{TRUE}, array-like objects
are treated as stored in HDF5 row-major rather than R column-major
orientation. Using \code{native = TRUE} increases HDF5 file portability
between programming languages. A file written with \code{native = TRUE}
should also be read with \code{native = TRUE}}
}
\value{
Returns \code{TRUE} if the dimension of the dataset was changed successfully
and \code{FALSE} otherwise.
}
\description{
Set a new dataset extension to an existing dataset in an HDF5 file
}
\examples{
tmpfile <- tempfile()
h5createFile(file=tmpfile)
h5createDataset(tmpfile, "A", c(10,12), c(20,24))
h5ls(tmpfile, all=TRUE)[c("dim", "maxdim")]
h5set_extent(tmpfile, "A", c(20,24))
h5ls(tmpfile, all=TRUE)[c("dim", "maxdim")]
}
\author{
Bernd Fischer, Mike Smith
}
|
