File: mockSCE.Rd

package info (click to toggle)
r-bioc-scuttle 1.16.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 912 kB
  • sloc: cpp: 531; sh: 7; makefile: 2
file content (39 lines) | stat: -rw-r--r-- 1,000 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/mockSCE.R
\name{mockSCE}
\alias{mockSCE}
\title{Mock up a SingleCellExperiment}
\usage{
mockSCE(ncells = 200, ngenes = 2000, nspikes = 100)
}
\arguments{
\item{ncells}{Integer scalar, number of cells to simulate.}

\item{ngenes}{Integer scalar, number of genes to simulate.}

\item{nspikes}{Integer scalar, number of spike-in transcripts to simulate.}
}
\value{
A SingleCellExperiment object containing a count matrix in the \code{"counts"} assay,
a set of simulated \code{\link{colData}} fields,
and spike-in data in the \code{"Spikes"} field of \code{\link{altExps}}.
}
\description{
Mock up a \linkS4class{SingleCellExperiment} containing simulated data,
for use in documentation examples.
}
\details{
Users should set a seed to obtain reproducible results from this function.
}
\examples{
set.seed(1000)
sce <- mockSCE()
sce

}
\seealso{
\code{\link{SingleCellExperiment}}, for the constructor.
}
\author{
Aaron Lun
}