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 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
|
\name{ReshapedHDF5ArraySeed-class}
\docType{class}
\alias{class:ReshapedHDF5ArraySeed}
\alias{ReshapedHDF5ArraySeed-class}
\alias{ReshapedHDF5ArraySeed}
\alias{dim,ReshapedHDF5ArraySeed-method}
\alias{extract_array,ReshapedHDF5ArraySeed-method}
\alias{chunkdim,ReshapedHDF5ArraySeed-method}
\title{ReshapedHDF5ArraySeed objects}
\description{
ReshapedHDF5ArraySeed is a low-level helper class for representing a
pointer to a virtually reshaped HDF5 dataset.
ReshapedHDF5ArraySeed objects are not intended to be used directly.
Most end users should create and manipulate \link{ReshapedHDF5Array}
objects instead. See \code{?\link{ReshapedHDF5Array}} for more information.
}
\usage{
## Constructor function:
ReshapedHDF5ArraySeed(filepath, name, dim, type=NA)
}
\arguments{
\item{filepath, name, dim, type}{
See \code{?\link{ReshapedHDF5Array}} for a description of these arguments.
}
}
\details{
No operation can be performed directly on a ReshapedHDF5ArraySeed object.
It first needs to be wrapped in a \link[DelayedArray]{DelayedArray}
object. The result of this wrapping is a \link{ReshapedHDF5Array} object
(a \link{ReshapedHDF5Array} object is just a ReshapedHDF5ArraySeed object
wrapped in a \link[DelayedArray]{DelayedArray} object).
}
\value{
A ReshapedHDF5ArraySeed object.
}
\seealso{
\itemize{
\item \link{ReshapedHDF5Array} objects.
\item \code{\link{h5ls}} to list the content of an HDF5 file.
}
}
\examples{
library(h5vcData)
tally_file <- system.file("extdata", "example.tally.hfs5",
package="h5vcData")
h5ls(tally_file)
## Collapse the first 2 dimensions:
seed <- ReshapedHDF5ArraySeed(tally_file, "/ExampleStudy/16/Coverages",
dim=c(12, 90354753))
seed
path(seed)
dim(seed)
chunkdim(seed)
}
\keyword{classes}
\keyword{methods}
|