import_mtxzip: Import Human Cell Atlas '.mtx.zip' archives

View source: R/import_mtxzip.R

import_mtxzipR Documentation

Import Human Cell Atlas '.mtx.zip' archives

Description

Import Human Cell Atlas '.mtx.zip' archives

Usage

import_mtxzip(
  path,
  ...,
  exdir = tempfile(),
  overwrite = FALSE,
  verbose = FALSE
)

Arguments

path

character(1) the path to the remote ('http://' or 'https://') or local '.zip' archive or, when '.data' is present, the column name (default '"path"') in which the path is found.

...

additional arguments, not supported.

exdir

character(1) directory in which to extract .zip archive.

overwrite

logical(1) overwrite existing files in 'exdir'?

verbose

logical(1) report progress using 'message()'.

Value

'SingleCellExperiment()' representing the expression data. Rows represent features and columns cells; counts are represented in a sparse matrix.

Examples

## Not run: 
    import_mtxzip("path/to/mtx/archive.zip")

## End(Not run)


Bioconductor/HCAMatrixBrowser documentation built on March 16, 2023, 6:16 a.m.