File: from_DelayedArray_to_simple_seed_class.Rd

package info (click to toggle)
r-bioc-delayedmatrixstats 1.28.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 620 kB
  • sloc: makefile: 2
file content (34 lines) | stat: -rw-r--r-- 1,150 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{from_DelayedArray_to_simple_seed_class}
\alias{from_DelayedArray_to_simple_seed_class}
\title{Coerce DelayedArray to its 'simple seed' form}
\usage{
from_DelayedArray_to_simple_seed_class(x, drop = FALSE, do_transpose = TRUE)
}
\arguments{
\item{x}{A \linkS4class{DelayedArray}}

\item{drop}{If \code{TRUE} the result is coerced to the lowest possible dimension}

\item{do_transpose}{Should transposed input be physically transposed?}
}
\value{
An object of the same class as \code{seedClass(x)}.
}
\description{
Coerce DelayedArray to its 'simple seed' form
}
\details{
Like \code{DelayedArray:::.from_DelayedArray_to_array} but returning an
object of the same class as \code{seedClass(x)} instead of an \emph{array}. In
doing so, all delayed operations are realised (including subsetting).
}
\note{
Can be more efficient to leave the transpose implicit
(\code{do_transpose = FALSE}) and switch from a \verb{row*()} method to a \verb{col*()}
method (or vice versa).

Only works on \linkS4class{DelayedArray} objects with 'simple seeds'
}
\keyword{internal}