read_h5_dgCMatrix: Read the /matrix from a .h5 file as a sparse matrix

Description Usage Arguments Value

View source: R/read_rna_h5.R

Description

Read the /matrix from a .h5 file as a sparse matrix

Usage

1
2
3
4
5
6
7
read_h5_dgCMatrix(
  h5_file,
  target = "matrix",
  feature_names = "id",
  sample_names = "barcodes",
  index1 = TRUE
)

Arguments

h5_file

the path to an .h5 file in 10x Genomics format

target

a character object specifying the target matrix within the file. Default is "matrix".

feature_names

a character object specifying whether to use "id" or "name" for row.names. Default is "id".

sample_names

a character object specifying which values to use for col.names. If "barcodes", will use /target/barcodes. Other values will be read from /target/observations/

index1

a logical object specifying whether index vectors should start with 0 (FALSE) or 1 (TRUE). Default is TRUE.

Value

a dgCMatrix of gene expression values.


AllenInstitute/BarMixer documentation built on Dec. 17, 2021, 8:42 a.m.