exportFromSCE: Export SingleCellExperiment (SCE) object to Cerebro.
In romanhaa/cerebroApp: Interactive visualization of scRNA-seq data with Cerebro

Description Usage Arguments Value Examples

This function allows to export a SingleCellExperiment (SCE) object to visualize in Cerebro.

exportFromSCE(
  object,
  assay = "logcounts",
  file,
  experiment_name,
  organism,
  groups,
  cell_cycle = NULL,
  nUMI = "nUMI",
  nGene = "nGene",
  add_all_meta_data = TRUE,
  use_delayed_array = FALSE,
  verbose = FALSE
)

`object`	`SingleCellExperiment` (`SCE`) object.
`assay`	Assay to pull expression values from; defaults to `logcounts`. It is recommended to use sparse data (such as log-transformed or raw counts) instead of dense data (such as the 'scaled' slot) to avoid performance bottlenecks in the Cerebro interface.
`file`	Where to save the output.
`experiment_name`	Experiment name.
`organism`	Organism, e.g. `hg` (human), `mm` (mouse), etc.
`groups`	Names of grouping variables in meta data (`colData(object)`), e.g. `c("sample","cluster")`; at least one must be provided; defaults to `NULL`.
`cell_cycle`	Names of columns in meta data (`colData(object)`) that# contain cell cycle information, e.g. `c("Phase")`; defaults to `NULL`.
`nUMI`	Column in `colData(object)` that contains information about number of transcripts per cell; defaults to `nUMI`.
`nGene`	Column in `colData(object)` that contains information about number of expressed genes per cell; defaults to `nGene`.
`add_all_meta_data`	If set to `TRUE`, all further meta data columns will be extracted as well.
`use_delayed_array`	When set to `TRUE`, the expression matrix will be stored as an `RleMatrix` (see `DelayedArray` package). This can be useful for very large data sets, as the matrix won't be loaded into memory and instead values will be read from the disk directly, at the cost of performance. Note that it is necessary to install the `DelayedArray` package. If set to `FALSE` (default), the expression matrix will be copied from the input object as is. It is recommended to use a sparse format, such as `dgCMatrix` from the `Matrix` package.
`verbose`	Set this to `TRUE` if you want additional log messages; defaults to `FALSE`.

No data returned.

pbmc <- readRDS(system.file("extdata/v1.3/pbmc_SCE.rds",
  package = "cerebroApp"))
exportFromSCE(
  object = pbmc,
  file = 'pbmc_SCE.crb',
  experiment_name = 'PBMC',
  organism = 'hg',
  groups = c('sample','cluster'),
  nUMI = 'nUMI',
  nGene = 'nGene',
  use_delayed_array = FALSE,
  verbose = TRUE
)