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
70
71
72
73
74
75
76
77
78
79
|
\name{realize}
\alias{BLOCK_write_to_sink}
\alias{realize}
\alias{realize,ANY-method}
\title{Realize a DelayedArray object}
\description{
Realize a \link{DelayedArray} object in memory or on disk.
}
\usage{
realize(x, ...)
\S4method{realize}{ANY}(x, BACKEND=getAutoRealizationBackend())
}
\arguments{
\item{x}{
The array-like object to realize.
}
\item{...}{
Additional arguments passed to methods.
}
\item{BACKEND}{
A single string specifying the name of the \emph{realization backend}.
Use the current \emph{automatic realization backend} by default i.e.
the backend returned by \code{\link{getAutoRealizationBackend}()}.
}
}
\value{
A \link{DelayedArray} object. More precisely, it returns
\code{DelayedArray(as.array(x))} when the backend is set to
\code{NULL} (the default). Otherwise it returns an instance of the
class associated with the specified backend (which should extend
\link{DelayedArray}).
}
\seealso{
\itemize{
\item \code{\link{getAutoRealizationBackend}} and
\code{\link{setAutoRealizationBackend}} for getting and setting
the current \emph{automatic realization backend}.
\item \link{DelayedArray} objects.
\item \link{RleArray} objects.
\item \link[HDF5Array]{HDF5Array} objects in the \pkg{HDF5Array} package.
\item \link[base]{array} objects in base R.
}
}
\examples{
library(HDF5Array)
toy_h5 <- system.file("extdata", "toy.h5", package="HDF5Array")
h5ls(toy_h5)
M1 <- HDF5Array(toy_h5, "M1")
M2 <- HDF5Array(toy_h5, "M2")
M3 <- rbind(log(M1), t(M2))
supportedRealizationBackends()
getAutoRealizationBackend() # backend is set to NULL
realize(M3) # realization as ordinary array
setAutoRealizationBackend("RleArray")
getAutoRealizationBackend() # backend is set to "RleArray"
realize(M3) # realization as RleArray object
setAutoRealizationBackend("HDF5Array")
getAutoRealizationBackend() # backend is set to "HDF5Array"
realize(M3) # realization in HDF5 file
}
\keyword{methods}
|
