anndata.io.read_loom

目录

anndata.io.read_loom#

anndata.io.read_loom(filename, *, sparse=True, cleanup=False, X_name='spliced', obs_names='CellID', obsm_names=None, var_names='Gene', varm_names=None, dtype='float32', obsm_mapping=mappingproxy({}), varm_mapping=mappingproxy({}), **kwargs)[source]#

读取 .loom 格式的 hdf5 文件。

这会将整个文件读入内存。

请注意,您必须明确说明何时希望将文件读取为稀疏数据。

Parameters:
filename PathLike

文件名。

sparse bool (default: True)

是否将数据矩阵作为稀疏矩阵读取。

cleanup bool (default: False)

是否将仅存储一个唯一值的所有 obs/var 字段合并为 .uns['loom-.']

X_name str (default: 'spliced')

用于初始化数据矩阵 X 的 Loompy 密钥。

obs_names str (default: 'CellID')

Loompy键用于存储观察/细胞名称。

obsm_mapping Mapping[str, Iterable[str]] (default: mappingproxy({}))

将构造为观察矩阵的Loompy键

var_names str (default: 'Gene')

Loompy键,其中存储变量/基因名称。

varm_mapping Mapping[str, Iterable[str]] (default: mappingproxy({}))

将构建为变量矩阵的Loompy键

NoneNone
**kwargs

loompy.connect 的参数

Return type:

AnnData

示例

pbmc = anndata.io.read_loom(
    "pbmc.loom",
    sparse=True,
    X_name="lognorm",
    obs_names="cell_names",
    var_names="gene_names",
    obsm_mapping={
        "X_umap": ["umap_1", "umap_2"]
    }
)