compareCountMatrix: Check count matrix consistency

Description Usage Arguments Value Examples

Description

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

Usage

1
2
3
4
5
6
7
compareCountMatrix(counts, celdaMod, ...)

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

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

Arguments

counts

Integer matrix. Rows represent features and columns represent cells.

celdaMod

A celdaModel or celdaList object.

...

Ignored. Placeholder to prevent check warning.

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

1
2
3
4
5

celda documentation built on Nov. 8, 2020, 8:24 p.m.