接口

中央类：

AnnData([X, obs, var, uns, obsm, varm, ...])

一个带注释的数据矩阵。

组合

合并 AnnData 对象。请参阅关于连接的部分。

concat(adatas, *[, axis, join, merge, ...])

沿着轴连接AnnData对象。

阅读

读取 anndata 的本地格式 .h5ad 和 zarr。

io.read_h5ad(filename[, backed, as_sparse, ...])	读取 .h5ad 格式的 hdf5 文件。
io.read_zarr(store)	从层次结构的 Zarr 数组存储中读取。

读取个别部分 (obs, varm 等) 的 AnnData 对象。

io.read_elem(elem)	从存储中读取一个元素。
io.sparse_dataset(group)	生成一个支持模式兼容的稀疏数据集类。

读取无法表示所有方面的 AnnData 对象的文件格式。

提示

通过从各个部分自行组装AnnData对象，您可能会更成功。

io.read_csv(filename[, delimiter, ...])	读取 .csv 文件。
io.read_excel(filename, sheet[, dtype])	读取 .xlsx（Excel）文件。
io.read_hdf(filename, key)	读取 .h5 (hdf5) 文件。
io.read_loom(filename, *[, sparse, cleanup, ...])	读取 .loom 格式的 hdf5 文件。
io.read_mtx(filename[, dtype])	读取 .mtx 文件。
io.read_text(filename[, delimiter, ...])	读取 .txt, .tab, .data（文本）文件。
io.read_umi_tools(filename[, dtype])	从 umi_tools 读取一个 gzipped 压缩计数矩阵。

写作

将完整的 AnnData 对象写入磁盘，使用anndata的原生格式 .h5ad 和 zarr。

AnnData.write([filename, compression, ...])	写入 .h5ad 格式的 hdf5 文件。
AnnData.write_zarr(store[, chunks])	写入层次Zarr数组存储。

写入单独的部分 (obs, varm 等) 的 AnnData 对象。

io.write_elem(store, k, elem, *[, ...])

使用anndata编码将一个元素写入存储组。

写入无法表示所有方面的 AnnData 对象的格式。

AnnData.write_csvs(dirname[, skip_data, sep])	将注释写入.csv文件。
AnnData.write_loom(filename[, write_obsm_varm])	写入 .loom 格式的 hdf5 文件。

实验性API

警告

实验模块中的API目前正在开发中，可能随时会发生变化。

两个类用于批量访问许多 AnnData 对象或 .h5ad 文件。特别是用于基于pytorch的模型。

experimental.AnnCollection(adatas[, ...])	懒惰地沿着 obs 轴连接 AnnData 对象。
experimental.AnnLoader(adatas[, batch_size, ...])	用于AnnData对象的PyTorch DataLoader。

核心外连接

experimental.concat_on_disk(in_files, ...[, ...])

沿指定轴连接多个AnnData对象，使用其对应的存储或路径，并将生成的AnnData对象写入磁盘上的目标位置。

用于将AnnData对象的元素读写到存储中的低级方法：

experimental.read_elem_as_dask(elem[, chunks])

懒惰地从存储中读取一个元素。

用于自定义IO过程的实用工具：

experimental.read_dispatched(elem, callback)	读取 elem，在每个子元素上调用回调函数。
experimental.write_dispatched(store, key, ...)	将元素写入存储，递归调用每个子元素的回调。

前者使用的类型：

experimental.IOSpec(encoding_type, ...)
experimental.Read	typing.Protocol。
experimental.Write	typing.Protocol。
experimental.ReadCallback	typing.Protocol。
experimental.WriteCallback	typing.Protocol。
experimental.StorageType	表示PEP 604联合类型

错误和警告

ImplicitModificationWarning

每当初始化一个对象或赋值一个属性时，若更改了参数的一部分的类型或被赋值的值，则会抛出该警告。

设置

settings	该管理器允许用户自定义anndata包的设置。
settings.override(**overrides)	通过关键字参数作为上下文管理器提供本地覆盖。

可读/可写元素的自定义类型/类

abc.CSRDataset()	磁盘上的CSR稀疏矩阵。
abc.CSCDataset()	磁盘上的CSC稀疏矩阵。
typing.Index	1D 或 2D 索引可以用来切片 AnnData 对象。
typing.AxisStorable	一个可序列化的对象，不包括anndata.AnnData对象，即可以存储在uns或obsm中的东西。
typing.RWAble	一个 anndata.typing.AxisStorable 的超集（即，包括 anndata.AnnData），它是所有可以被 anndata.io.read_elem() 和 anndata.io.write_elem() 读/写的内容。