Check count matrix consistency

Source: R/celda_functions.R

Checks if the counts matrix is the same one used to generate the celda model object by comparing dimensions and MD5 checksum.

compareCountMatrix(counts, celdaMod, errorOnMismatch = TRUE)

# S4 method for class 'ANY,celdaModel'
compareCountMatrix(counts, celdaMod, errorOnMismatch = TRUE)

# S4 method for class 'ANY,celdaList'
compareCountMatrix(counts, celdaMod, errorOnMismatch = TRUE)

Arguments

counts

Integer , Numeric, or Sparse matrix. Rows represent features and columns represent cells.

celdaMod

A celdaModel or celdaList object.

errorOnMismatch

Logical. Whether to throw an error in the event of a mismatch. Default TRUE.

Value

Returns TRUE if provided count matrix matches the one used in the celda object and/or errorOnMismatch = FALSE, FALSE otherwise.

Examples

data(celdaCGSim, celdaCGMod)
compareCountMatrix(celdaCGSim$counts, celdaCGMod, errorOnMismatch = FALSE)
#> [1] TRUE
data(celdaCGSim, celdaCGGridSearchRes)
compareCountMatrix(celdaCGSim$counts, celdaCGGridSearchRes,
    errorOnMismatch = FALSE)
#> [1] TRUE