Skip to content

Add support for seurat hdf5 format. #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions R/H5SparseMatrixSeed-class.R
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,12 @@ read_h5sparse_component <- function(filepath, group, name,
## 10x format
return(read_h5sparse_component(filepath, group, "shape"))
}
## h5ad format
h5attrs <- h5readAttributes(filepath, group)
## h5seurat format
shape <- h5attrs$dims
if(!is.null(shape))
return(as.vector(shape))
## h5ad format
shape <- h5attrs$shape
if (is.null(shape))
shape <- h5attrs$h5sparse_shape
Expand All @@ -157,8 +161,12 @@ read_h5sparse_component <- function(filepath, group, name,
## 10x format
return("csr")
}
## h5ad format
h5attrs <- h5readAttributes(filepath, group)
## h5seurat format
shape <- h5attrs$dims
if(!is.null(shape))
return("csr")
## h5ad format
h5sparse_layout <- h5attrs[["encoding-type"]]
if (is.null(h5sparse_layout))
h5sparse_layout <- h5attrs[["h5sparse_format"]]
Expand Down
33 changes: 24 additions & 9 deletions R/TENxMatrixSeed-class.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,31 @@ setClass("TENxMatrixSeed", contains="CSC_H5SparseMatrixSeed")

.find_rownames_dataset <- function(filepath, group)
{
name <- "genes"
if (h5exists(filepath, paste(group, name, sep="/")))
return(name)
name <- "features/id"
if (h5exists(filepath, paste(group, name, sep="/")))
return(name)
# features is for h5seurat.
candidate <- c("genes", "features", "features/id")
for(i in candidate)
{
if (h5exists(filepath, file.path(group, i)))
return(i)
}
NULL
}

.read_h5seurat_component <- function(filepath, name){
if (h5exists(filepath, name))
return(as.vector(h5mread(filepath, name)))
NULL
}

### Return the rownames of the matrix.
.load_tenx_rownames <- function(filepath, group)
{
name <- .find_rownames_dataset(filepath, group)
# h5seurat data location: /path/to/group/../features
# Find dataset in altered group
if (is.null(name)){
group <- gsub('/[^/]+$','',group)
name <- .find_rownames_dataset(filepath, group)}
if (is.null(name))
return(NULL)
read_h5sparse_component(filepath, group, name)
Expand All @@ -33,9 +45,12 @@ setClass("TENxMatrixSeed", contains="CSC_H5SparseMatrixSeed")
### Return the colnames of the matrix.
.load_tenx_barcodes <- function(filepath, group)
{
if (!h5exists(filepath, paste0(group, "/barcodes")))
return(NULL)
read_h5sparse_component(filepath, group, "barcodes")
if (h5exists(filepath, paste0(group, "/barcodes")))
return(read_h5sparse_component(filepath, group, "barcodes"))
# h5seurat
if (h5exists(filepath, "cell.names"))
return(read_h5sparse_component(filepath, '', "cell.names"))
NULL
}


Expand Down
14 changes: 14 additions & 0 deletions man/TENxMatrix-class.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,20 @@ n_exprs3 <- lengths(nonzeros)
## Sanity checks:
stopifnot(all.equal(lib_sizes, lib_sizes3))
stopifnot(all.equal(n_exprs, n_exprs3))

## ---------------------------------------------------------------------
## SOME EXAMPLES OF H5SEURAT FORMAT
## ---------------------------------------------------------------------
fpath <- system.file('extdata','toy.h5seurat',package="HDF5Array")
# Read count data of h5seurat dataset.
group <- '/assays/RNA/counts'
df.count <- HDF5Array::TENxMatrix(fpath, group)
df.count[1:10,2:9]

# Read normalized data of h5seurat dataset.
group <- '/assays/RNA/data'
df.data <- HDF5Array::TENxMatrix(fpath, group)
df.data[1:10,2:9]
}
\keyword{classes}
\keyword{methods}