multimodal_ondisc_matrix: 'multimodal_ondisc_matrix' class

Description Usage Arguments Value Slots Examples

View source: R/s4_classes.R

Description

A multimodal_ondisc_matrix represents multimodal data.

Construct a multimodal_ondisc_matrix from a list of metadata_ondisc_matrix objects.

Usage

1
2
3
multimodal_ondisc_matrix(metadata_ondisc_matrix_list)

multimodal_ondisc_matrix(metadata_ondisc_matrix_list)

Arguments

metadata_ondisc_matrix_list

a named list containing metadata_ondisc_matrices; the names are taken to be the names of the modalities.

Value

a multimodal_ondisc_matrix

Slots

modalities

a list containing metadata_ondisc_matrix objects representing different modalities.

global_cell_covariates

a data frame containing the cell-specific covariates pooled across all modalities.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# NOTE: You must create the RDS files "expressions.rds" and
# "perturbations.rds" to run this example. Navigate to the help file of
# "create_ondisc_matrix_from_mtx" (via ?create_ondisc_matrix_from_mtx),
# and execute both code blocks.
expression_fp <- paste0(tempdir(), "/expressions.rds")
perturbations_fp <- paste0(tempdir(), "/perturbations.rds")
if (file.exists(expression_fp) && file.exists(perturbations_fp)) {
    expressions <- readRDS(expression_fp)
    perturbations <- readRDS(perturbations_fp)
    crispr_experiment <- multimodal_ondisc_matrix(list(expressions = expressions,
    perturbations = perturbations))
}

ondisc documentation built on March 5, 2021, 5:07 p.m.