crisprme-data
收藏资源简介:
CRISPRme 参考数据与预计算索引数据集旨在加速 CRISPRme 基因编辑脱靶分析工具的初始设置过程。该数据集托管了 CRISPRme 所需的参考资源(包括参考基因组、变体 VCF、注释文件、PAM 序列和样本 ID 列表),并提供了预计算的索引,使用户可以跳过原始数据下载、变异富集和索引构建的耗时步骤。数据内容按目录结构组织:`genomes/` 目录包含 hg38 参考基因组的每条染色体 FASTA 文件;`vcfs/` 目录包含 1000 Genomes Phase 3 (GRCh38)、人类基因组多样性计划 (HGDP) 以及合并队列的 VCF 文件;`annotations/` 目录包含 DHS+ENCODE+GENCODE 以及 GENCODE 蛋白编码基因的 BED 注释文件;`pams/` 目录包含 PAM 序列文件(如 20bp-NGG-spCas9.txt 和 NNN 基序);`samplesIDs/` 目录包含每个数据集的样本 ID 列表;`indexes/` 目录包含预计算的基因组文库和富集索引,例如 `NGG_1000G+HGDP+TOPMed+AllofUs/`、`NNN_1000G+HGDP/` 和 `NGG_pangenome2.0/`。该数据集主要适用于 CRISPRme 用户进行脱靶分析,通过使用预计算索引将基因组范围的设置时间从数小时缩短至几分钟。数据集遵循 AGPL-3.0 许可证,并引用 Cancellieri 等人 2023 年发表于《自然·遗传学》的论文。
The CRISPRme Reference Data and Precomputed Indexes dataset is designed to accelerate the initial setup of the CRISPRme off-target analysis tool. It hosts reference resources required by CRISPRme (including reference genome, variant VCFs, annotation files, PAM sequences, and sample ID lists) and provides precomputed indexes, allowing users to skip time-consuming steps of raw data download, variant enrichment, and index building. The data is organized in directories: `genomes/` contains FASTA files for each chromosome of the hg38 reference genome; `vcfs/` contains VCF files from the 1000 Genomes Phase 3 (GRCh38), the Human Genome Diversity Project (HGDP), and merged cohorts; `annotations/` contains BED annotation files for DHS+ENCODE+GENCODE and GENCODE protein-coding genes; `pams/` contains PAM sequence files (e.g., 20bp-NGG-spCas9.txt and NNN motifs); `samplesIDs/` contains sample ID lists for each dataset; `indexes/` contains precomputed genome libraries and enrichment indexes, such as `NGG_1000G+HGDP+TOPMed+AllofUs/`, `NNN_1000G+HGDP/`, and `NGG_pangenome2.0/`. This dataset is primarily intended for CRISPRme users performing off-target analysis, reducing genome-wide setup time from hours to minutes by using precomputed indexes. It is licensed under AGPL-3.0 and cites the paper by Cancellieri et al. 2023 in Nature Genetics.
数据集概述
CRISPRme reference data & precomputed indexes 是一个为 CRISPRme 工具提供参考数据和预计算索引的数据集。该数据集旨在通过提供快速、可靠的镜像资源,显著加速 CRISPRme 的基因组规模运行,将原本需要数小时的下载和索引构建过程缩短至几分钟。
核心目标与动机
- 加速数据获取:上游数据源(如 EBI 和 UCSC)下载速度慢(约 1.4 MB/s),而 Hugging Face 的 CDN 速度是其约 6.5 倍。
- 消除计算瓶颈:变体富集(variant enrichment)阶段占整个运行时间的约 93%(约 13.5 小时中的 12.5 小时),预计算索引可直接跳过该步骤。
- 简化用户操作:用户无需下载原始数据或构建索引,直接使用预计算索引即可完成设置。
数据集内容与布局
目标目录结构包括以下类别:
| 目录 | 内容 |
|---|---|
genomes/hg38/ |
GRCh38 每个染色体的 FASTA 文件(chr1.fa … chrX.fa) |
vcfs/ |
1000 Genomes Phase 3 (GRCh38)、HGDP 样本及合并队列的 VCF 文件 |
annotations/ |
功能注释文件(如 dhs+encode+gencode.hg38.bed、gencode.protein_coding.bed) |
pams/ |
PAM 序列文件(如 20bp-NGG-spCas9.txt、NNN motif) |
samplesIDs/ |
各数据集的样本 ID 列表 |
indexes/ |
预计算的基因组库和富集索引 |
默认预计算索引
数据集包含以下三种预计算索引配置:
- NGG_1000G+HGDP+TOPMed+AllofUs:统一的大规模队列面板(1000G + HGDP + TOPMed + All of Us),是论文中重点提到的参考配置。
- NNN_1000G+HGDP:向后兼容原始 CRISPRme 的配置,使用 NNN PAM。
- NGG_pangenome2.0:基于 Pangenome 2.0 VCF 的索引。
此外,还提供默认的 NNN 和 NGG 两种 PAM 配置。
使用方式
- 自动集成:CRISPRme 的
setup功能可直接从本仓库拉取资源,替代原始慢速上游主机。 - 手动下载:支持直接下载整个仓库(需注意数据量较大),命令示例: bash hf download pinellolab/crisprme-data --repo-type dataset --local-dir crisprme-data
许可与引用
- 许可协议:参考数据按其原始来源(1000 Genomes、HGDP、GENCODE/ENCODE、UCSC hg38 等)的条款进行再分发;CRISPRme 本身采用 AGPL-3.0 许可。
- 引用信息:若使用 CRISPRme,请引用:
Cancellieri S, et al. Human genetic diversity alters off-target outcomes of therapeutic gene editing. Nat Genet 55, 34–43 (2023). doi:10.1038/s41588-022-01257-y
- 项目主页:https://github.com/pinellolab/CRISPRme
注意事项
- 当前仓库状态为 🚧 建设中(work in progress),部分资源尚未完全上传,上述目录结构为目标形态。
- 数据集不支持浏览器查看(
viewer: false)。




