CheckMatrix_scCustom: Check Matrix Validity

In samuel-marsh/scCustomize: Custom Visualizations & Functions for Streamlined Analyses of Single Cell Sequencing

Check Matrix Validity

Description

Native implementation of SeuratObjects CheckMatrix but with modified warning messages.

Usage

CheckMatrix_scCustom(
  object,
  checks = c("infinite", "logical", "integer", "na")
)

Arguments

object	A matrix
checks	Type of checks to perform, choose one or more from: “infinite”: Emit a warning if any value is infinite “logical”: Emit a warning if any value is a logical “integer”: Emit a warning if any value is not an integer “na”: Emit a warning if any value is an NA or NaN

Value

Emits warnings for each test and invisibly returns NULL

References

Re-implementing CheckMatrix only for sparse matrices with modified warning messages. Original function from SeuratObject https://github.com/satijalab/seurat-object/blob/9c0eda946e162d8595696e5280a6ecda6284db39/R/utils.R#L625-L650 (License: MIT).

Examples

## Not run: 
mat <- Read10X(...)
CheckMatrix_scCustom(object = mat)

## End(Not run)

samuel-marsh/scCustomize documentation built on Dec. 20, 2024, 7:41 a.m.