Omnition 是一个管道,旨在处理使用 Bio-Rad 的 ddSEQ™ 单细胞 3' RNA-Seq 试剂盒或 ddSEQ™ SureCell ATAC-Seq 文库制备试剂盒和 dsciATAC 协议生成的数据。它执行去条形码、对齐、珠子合并、单元调用和特征计数。输出是 HTML 报告和用于下游生物分析的文件。
此页面旨在作为快速入门。有关完整的 Omnition 用户指南,请参阅:
Omnition 单细胞 3' RNA 测序
Omnition 单细胞 ATAC 测序
Omnition简介
安装
系统要求
硬件要求
软件要求
下载全能
验证安装
入门
YAML 配置
运行 ATAC 管道
运行 RNA 管道
人类基因组
小鼠基因组
参考
跑步全能
输出
Omnition Analysis Software 利用 Nextflow 框架连接各个进程,并使用 Docker 或 Singularity 容器程序在称为容器的虚拟环境中运行进程。一旦 Omnition 安装在满足最低要求的系统上,Nextflow 与 GitHub 和 Docker 的集成将准备工作流程,无需任何额外配置。
Omnition 设计为在本地 Linux 服务器、高性能计算 (HPC) 集群或云虚拟机上运行,并已在 64 位 CentOS 7 和 8、Amazon Linux 2 以及 Ubuntu 18.04.6、20.04 LTS 上进行了测试、21.04 和 21.10 Linux 操作系统。
注意:虽然它们可能有效,但 Bio-Rad 不支持其他 Linux 变体或指定操作系统的其他版本。
互联网连接
注意:对于无需直接访问互联网的安装,请参阅用户手册。
要求 | ATAC 序列分析 | 组合 ATAC seq 分析 | RNA序列分析 | 建议用于 >=12x 样本 |
---|---|---|---|---|
中央处理器 | 16 | 16 | 16 | 64 |
内存 | 64GB | 128GB | 64GB | 512GB |
IOPS* | 3,000 | 3,000 | 3,000 | 16,000 |
I/O 吞吐量* | 125 Mbps | 125 Mbps | 125 Mbps | 1,000 Mbps |
EBS 卷类型* | GP3 | GP3 | GP3 | GP3 |
*AWS特定云计算规范
Nextflow(v22.04.0 至 v23.10.1)或 Nextflow 与 Conda
注意:使用以下命令在 Conda 安装中指定 Nextflow 版本:
conda install –c bioconda nextflow=
只需要以下容器程序之一:Docker (>=20.10.7) 或 Singularity (>=3.6.4)
注意:如果使用 Docker,则在执行管道之前必须将您的
USER
添加到 docker root 用户组。在共享系统(例如 HPC 集群)上,由于安全风险,这可能无法实现,并且应使用 Singularity 配置文件(默认)来执行管道。在使用 Omnition 之前,用户必须向系统管理员验证 Docker 或 Singularity 是否可用。
要下载并运行 Omnition,请使用 nextflow 从 GitHub 检索最新的 Omnition 版本。
nextflow pull BioRadOpenSource/omnition
Omnition 包含小型演示数据集,用于验证环境是否已正确构建以及所有软件依赖项是否已就位。要验证每种分析类型的安装是否成功,请为计算机上安装的容器系统(Singularity 或 Docker)运行 Nextflow 命令。
要验证每个分析工作流程是否已正确安装,请使用 Docker 或 Singularity 运行以下命令。
注意:工作文件(和输出文件,除非另有指定)将在命令行上运行管道的同一目录中生成。
mkdir /home/ubuntu/demo_data cd /home/ubuntu/demo_data
注意:指定的文件路径仅供示例之用
码头工人:
# Verify single and mixed species 3’ RNA workflows nextflow run BioRadOpenSource/omnition -profile demo_rna_single,docker --rna.output /home/ubuntu/demo_data/rna nextflow run BioRadOpenSource/omnition -profile demo_rna_mixed_options,docker --rna.output /home/ubuntu/demo_data/rna_mixed # Verify ATAC-seq and combinatorial ATAC-seq workflows nextflow run BioRadOpenSource/omnition -profile demo_atac,docker --atac.output /home/ubuntu/demo_data/atac nextflow run BioRadOpenSource/omnition -profile demo_catac,docker --catac.output /home/ubuntu/demo_data/catac
奇点:
# Verify single and mixed species 3’ RNA workflows nextflow run BioRadOpenSource/omnition -profile demo_rna_single,standard --rna.output /home/ubuntu/demo_data/rna nextflow run BioRadOpenSource/omnition -profile demo_rna_mixed_options,standard --rna.output /home/ubuntu/demo_data/rna_mixed # Verify ATAC-seq and combinatorial ATAC-seq workflows nextflow run BioRadOpenSource/omnition -profile demo_atac,standard --atac.output /home/ubuntu/demo_data/atac nextflow run BioRadOpenSource/omnition -profile demo_catac,standard --catac.output /home/ubuntu/demo_data/catac
注意:请注意执行命令中
-
和--
的使用。前面带有单个-
参数是 Nextflow 参数,带有--
的参数是用户定义的参数。您还可以使用 Nextflow -r 标志来指定 git 标签(即版本)、分支或哈希,以在 git 历史记录中的该点执行管道。
注意:启动 nextflow 运行时,终端中将出现一个随机生成的 [adjective_names]。这些名称来自 Nextflow 准备的列表。这是 nextflow 的固有功能,并非 Bio-Rad 添加的功能。
运行完成后,您应该会看到一条消息,表明运行已完成,没有任何失败的任务。
在运行工作流程之前,Omnition 需要运行以下文件:
来自 ENSEMBL 的基因组 FASTA 和 GTF 文件。
基因组参考序列必须格式化为 FASTA 文件。
注释必须采用 GTF 文件格式。
FASTA 和 GTF 文件中的序列名称必须匹配。
包含输入 FASTQ 的目录
注意:输入参考文件可以压缩为 gzip (.gz) 文件
Omnition 与 ENSEMBL 的参考文献兼容。 Omnition 支持 ENSEMBL Human/GRCh38 和 Mouse/GRCm39 参考。不支持 ENSEMBL 中的其他物种,并且其他来源(NCBI、GENCODE 等)生成的参考不兼容。
可以使用以下命令获取人类和小鼠参考。
mkdir ~/references/human cd ~/references/human
注意:指定的文件路径仅供示例之用
curl -o Homo_sapiens.GRCh38.dna.primary_assembly.fa.gz http://ftp.ensembl.org/pub/release-106/fasta/homo_sapiens/dna/Homo_sapiens.GRCh38.dna.primary_assembly.fa.gz curl -o Homo_sapiens.GRCh38.106.gtf.gz http://ftp.ensembl.org/pub/release-106/gtf/homo_sapiens/Homo_sapiens.GRCh38.106.gtf.gz
mkdir ~/references/mouse cd ~/references/mouse
curl -o Mus_musculus.GRCm39.dna.primary_assembly.fa.gz http://ftp.ensembl.org/pub/release-106/fasta/mus_musculus/dna/Mus_musculus.GRCm39.dna.primary_assembly.fa.gz curl -o Mus_musculus.GRCm39.106.gtf.gz http://ftp.ensembl.org/pub/release-106/gtf/mus_musculus/Mus_musculus.GRCm39.106.gtf.gz
当不运行测试数据时,管道需要一个 YAML 格式的文件,其中包含输入/输出路径和特定于分析的参数。文件内容、可用参数以及如何格式化它们的详细说明可以在用户手册中找到。示例 YAML 配置可以在此存储库的 example-yamls 文件夹下找到。
具有奇异性:
nextflow run BioRadOpenSource/omnition -params-file
使用 Docker:
nextflow run BioRadOpenSource/omnition -params-file-profile docker
具有奇异性:
nextflow run BioRadOpenSource/omnition -params-file
使用 Docker:
nextflow run BioRadOpenSource/omnition -params-file-profile docker
完成后,可以在results/report/
子目录中找到报告,可以在results/Sample_Files/
子目录中找到中间文件。此外,将在执行 Nextflow 的目录中创建 Nextflow 缓存目录 ( .nextflow/
) 和工作目录 ( work/
)。这允许中断/失败的分析从故障点恢复。如果您想继续运行,请将-resume
添加到下面的执行命令中。您可以在完成后删除缓存和工作目录以节省空间,但这会抑制-resume
功能。
返回顶部