File: RleArraySeed-class.Rd

package info (click to toggle)
r-bioc-delayedarray 0.24.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,480 kB
  • sloc: ansic: 727; makefile: 2
file content (63 lines) | stat: -rw-r--r-- 1,732 bytes parent folder | download | duplicates (3)
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
\name{RleArraySeed-class}
\docType{class}

\alias{class:RleArraySeed}
\alias{RleArraySeed-class}
\alias{RleArraySeed}

\alias{class:SolidRleArraySeed}
\alias{SolidRleArraySeed-class}
\alias{SolidRleArraySeed}

\alias{class:RleRealizationSink}
\alias{RleRealizationSink-class}
\alias{RleRealizationSink}

\alias{type,RleRealizationSink-method}

\alias{class:ChunkedRleArraySeed}
\alias{ChunkedRleArraySeed-class}
\alias{ChunkedRleArraySeed}

\alias{dim,RleArraySeed-method}
\alias{dimnames,RleArraySeed-method}

\alias{coerce,SolidRleArraySeed,Rle-method}
\alias{coerce,RleRealizationSink,RleList-method}
\alias{coerce,RleRealizationSink,Rle-method}

\alias{extract_array,SolidRleArraySeed-method}
\alias{extract_array,ChunkedRleArraySeed-method}

\alias{coerce,RleRealizationSink,ChunkedRleArraySeed-method}

\alias{coerce,ChunkedRleArraySeed,SolidRleArraySeed-method}

\title{RleArraySeed objects}

\description{
  RleArraySeed is a low-level helper class for representing an in-memory
  Run Length Encoded array-like dataset.
  RleArraySeed objects are not intended to be used directly. Most
  end users should create and manipulate \link{RleArray} objects
  instead. See \code{?\link{RleArray}} for more information.
}

\details{
  No operation can be performed directly on an RleArraySeed object.
  It first needs to be wrapped in a \link[DelayedArray]{DelayedArray}
  object. The result of this wrapping is an \link{RleArray} object
  (an \link{RleArray} object is just an RleArraySeed object wrapped
  in a \link[DelayedArray]{DelayedArray} object).
}

\seealso{
  \itemize{
    \item \link{RleArray} objects.

    \item \link[S4Vectors]{Rle} objects in the \pkg{S4Vectors} package.
  }
}

\keyword{classes}
\keyword{methods}