Scrublet 开源项目使用教程

Scrublet 开源项目使用教程

scrubletDetect doublets in single-cell RNA-seq data项目地址:https://gitcode.com/gh_mirrors/sc/scrublet

1. 项目的目录结构及介绍

Scrublet 项目的目录结构如下：

scrublet/
├── examples/
│   ├── example_dataset.h5ad
│   ├── example_scrublet.ipynb
│   └── example_scrublet.py
├── scrublet/
│   ├── __init__.py
│   ├── scrublet.py
│   └── utils.py
├── tests/
│   ├── test_scrublet.py
│   └── test_utils.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍：

• examples/: 包含示例数据集和示例代码，帮助用户快速上手 Scrublet。

  • example_dataset.h5ad: 示例数据集文件。
  • example_scrublet.ipynb: Jupyter Notebook 格式的示例代码。
  • example_scrublet.py: Python 脚本格式的示例代码。

• scrublet/: 核心代码目录，包含 Scrublet 的主要功能实现。

  • __init__.py: 初始化文件，使 scrublet 成为一个 Python 包。
  • scrublet.py: Scrublet 的主要功能实现文件。
  • utils.py: 辅助工具函数文件。

• tests/: 包含测试代码，用于确保 Scrublet 的正确性和稳定性。

  • test_scrublet.py: 测试 Scrublet 主要功能的测试文件。
  • test_utils.py: 测试辅助工具函数的测试文件。

• .gitignore: Git 忽略文件，指定不需要版本控制的文件和目录。

• LICENSE: 项目许可证文件，采用 MIT 许可证。

• README.md: 项目介绍和使用说明文件。

• requirements.txt: 项目依赖库列表。

• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

Scrublet 项目的启动文件是 scrublet/scrublet.py。该文件包含了 Scrublet 的主要功能实现，用户可以通过导入该文件中的类和函数来使用 Scrublet 进行双细胞检测。

主要功能：

• Scrublet: 主类，用于初始化和运行双细胞检测。
• scrublet: 函数，用于直接调用双细胞检测功能。

使用示例：

from scrublet import Scrublet

# 初始化 Scrublet 对象
scrub = Scrublet(counts_matrix)

# 运行双细胞检测
doublet_scores, predicted_doublets = scrub.scrub_doublets()

3. 项目的配置文件介绍

Scrublet 项目没有专门的配置文件，用户可以通过代码中的参数来配置 Scrublet 的行为。主要的配置参数包括：

• expected_doublet_rate: 预期的双细胞率，默认为 0.06。
• sim_doublet_ratio: 模拟双细胞的比例，默认为 2.0。
• n_neighbors: 计算双细胞分数时的邻居数量，默认为 None，表示自动选择。
• min_counts: 过滤低表达基因的阈值，默认为 3。
• min_cells: 过滤低表达细胞的阈值，默认为 3。
• min_gene_variability_pctl: 选择高变异基因的百分位数，默认为 85。
• log_transform: 是否对数据进行对数转换，默认为 False。

配置示例：

scrub = Scrublet(counts_matrix, 
                 expected_doublet_rate=0.1, 
                 sim_doublet_ratio=3.0, 
                 n_neighbors=20)

通过调整这些参数，用户可以根据具体的数据集和需求来优化双细胞检测的效果。

scrubletDetect doublets in single-cell RNA-seq data项目地址:https://gitcode.com/gh_mirrors/sc/scrublet