Merge_Sparse_Data_All: Merge a list of Sparse Matrices

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

Merge a list of Sparse Matrices

Description

Enables easy merge of a list of sparse matrices

Usage

Merge_Sparse_Data_All(
  matrix_list,
  add_cell_ids = NULL,
  prefix = TRUE,
  cell_id_delimiter = "_"
)

Arguments

matrix_list	list of matrices to merge.
add_cell_ids	a vector of sample ids to add as prefix to cell barcode during merge.
prefix	logical. Whether add_cell_ids should be added as prefix to current cell barcodes/names or as suffix to current cell barcodes/names. Default is TRUE, add as prefix.
cell_id_delimiter	The delimiter to use when adding cell id prefix/suffix. Default is "_".

Value

A sparse Matrix

References

Original function is part of LIGER package https://github.com/welch-lab/liger/blob/master/R/mergeObject.R (License: GPL-3). Function was modified for use in scCustomize (add progress bar, prefix vs. suffix, and delimiter options).

Examples

## Not run: 
data_list <- Read10X_GEO(...)
merged <- Merge_Sparse_Data_All(matrix_list = data_list, add_cell_ids = names(data_list),
prefix = TRUE, cell_id_delimiter = "_")

## End(Not run)

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