WarpDemuX

WarpDemuX

WarpDemuX是一款用于纳米孔直接RNA测序的超快速、高精度接头条形码标记和解复用工具。它通过以下方式提高速度和准确性：

• 快速处理原始信号
• 轻量级机器学习算法
• 优化的条形码集
• 通过特定条形码的自适应采样实现实时富集能力

目前支持SQK-RNA002和SQK-RNA004两种化学试剂。

快速开始

安装大约需要10分钟：

# 克隆包含子模块的仓库
git clone --recursive https://github.com/KleistLab/WarpDemuX.git [存储WarpDemuX的路径]# 使用environment.yml文件创建一个新的conda环境
# 建议使用mamba代替conda以提高速度
mamba env create -n WDX -f [存储WarpDemuX的路径]/environment.yml
mamba activate WDX# 以可编辑模式安装
pip install -e [存储WarpDemuX的路径]# 用于特定条形码的自适应采样
cd [存储WarpDemuX的路径]
pip install -e '.[live-demux]'

使用不同分支

切换到不同分支后，需要更新子模块。

例如，切换到dev分支：

git switch dev && git submodule update

切换回main分支：

git switch main && git submodule update

非可编辑模式

WarpDemuX依赖于ADAPTed，这是我们用于接头和poly(A)尾检测的工具。目前，ADAPTed作为子模块包含在内。为确保WDX能够正确访问该模块，需要以可编辑模式安装WDX。请参见上文。

如果不想以可编辑模式安装，可以分别安装warpdemux和adapted包：

cd [存储WarpDemuX的路径]
pip install .cd warpdemux/adapted
pip install .

如果选择这种方法，每次切换分支时都需要重新安装这两个包。

基本用法

conda activate WDX
warpdemux demux -i 输入文件 [输入文件 ...] -o 输出路径 -m 模型名称 -j 核心数

其中：

• 输入文件：要解复用的Pod5文件或目录
• 输出路径：运行输出文件夹的路径
• 模型名称：要使用的模型（请参见模型部分）
• 核心数：用于并行处理的核心数量

有关更多说明和选项，请运行warpdemux --help和warpdemux demux --help。

工作流选项

指纹识别（仅预处理）

预处理原始信号以获得条形码指纹，而不进行条形码预测。
当您想在相同的预处理数据上使用不同的分类模型时，这很有用。

warpdemux prep -i 输入文件 [输入文件 ...] -o 输出路径 -m 模型名称 -j 核心数 ...

使用--export /有效配置文件的路径/config.toml指定预处理步骤的自定义配置文件，例如，当您正在开发新模型时。

有关更多信息，请参见warpdemux prep --help。

仅预测（predict）

对之前预处理的指纹进行条形码预测：

warpdemux predict 预测来源目录

其中预测来源目录是/warpdemux输出路径目录，包含command.json文件。只有在之前运行过prep命令后才能运行此命令。

有关更多信息，请参见warpdemux predict --help。

继续之前的运行（continue）

使用可选的运行时参数更新恢复中断的运行：

warpdemux continue 继续运行的目录

其中继续运行的目录是/warpdemux输出路径目录，包含command.json文件。您可以继续prep、demux