sagebionetworks/genie

AACR Project GENIE Docker镜像文档

!https://raw.githubusercontent.com/Sage-Bionetworks/Genie/master/genie_banner.png

![PyPi]([***]

镜像概述

该Docker镜像封装了AACR Project GENIE（Genomics, Evidence, Neoplasia, Information, Exchange）项目的数据处理工具链，用于收集、质量控制（QC）、标准化和分析参与机构上传的数据。镜像集成了Python、R及CLI工具，支持数据贡献者本地文件验证、项目数据流程管理及多环节数据处理需求。

核心功能与特性

• 文件验证工具：提供本地验证功能，支持数据贡献者在上传至Synapse前验证文件格式及内容合规性。
• 多语言支持：集成Python（≥3.10且<3.12）、R 4.3.3及CLI工具，满足复杂数据处理流程需求。
• 数据流程管理：支持数据收集、QC、标准化、分析全流程，包含突变数据处理、联盟数据发布等专项功能。
• 依赖集成：内置bedtools、Java 21、wget等必要工具，简化环境配置。

使用场景

• 数据贡献者：本地验证临床数据、CNA数据等文件格式，确保上传数据合规。
• 项目管理员：管理参与机构数据上传流程，执行数据质量控制与标准化。
• 开发人员：本地开发、测试数据处理 pipeline，参与工具功能迭代。

依赖要求

容器内部已预装以下依赖，外部使用需注意：

• Python：≥3.10 且 <3.12
• R：4.3.3
• 系统工具：bedtools、Java 21、wget
• Synapse认证：需通过.synapseConfig文件或环境变量配置访问权限

使用方法

获取镜像

从Docker Hub拉取最新镜像：

bash
docker pull sagebionetworks/genie

启动容器

以交互式模式启动容器，挂载本地数据目录（如./data）至容器内/data：

bash
docker run -it -v $(pwd)/data:/data sagebionetworks/genie /bin/bash

文件验证工具使用

环境配置（容器内）

1. 验证安装
   检查genie工具版本：

   bash
   genie -v
   

2. Synapse认证配置
   通过环境变量设置认证令牌（推荐）：

   bash
   export SYNAPSE_AUTH_TOKEN=<your_synapse_token>
   

   或创建~/.synapseConfig文件：

   ini
   [authentication]
   authtoken = <your_synapse_token>
   

运行验证器

获取验证命令帮助：

bash
genie validate -h

示例命令

1. 验证临床文件

   bash
   genie validate /data/data_clinical_supp_SAGE.txt SAGE
   

2. 验证CNA文件
   对CNA文件需添加--nosymbol-check标志（非开发环境）：

   bash
   genie validate /data/data_cna_SAGE.txt SAGE --nosymbol-check
   

Sage Bionetworks内部使用（开发与生产）

本地开发

1. 克隆代码库并安装开发依赖：

   bash
   git clone https://github.com/Sage-Bionetworks/Genie.git
   cd Genie
   pip install -e .
   pip install -r requirements-dev.txt
   

2. 运行测试 pipeline（如验证所有文件）：

   bash
   python bin/input_to_database.py main --project_id syn7208886 --onlyValidate
   

生产环境

生产流程基于Nextflow Tower运行，具体参考https://github.com/Sage-Bionetworks-Workflows/nf-genie%E9%A1%B9%E7%9B%AE%EF%BC%8C%E5%8C%85%E5%90%AB%E7%AA%81%E5%8F%98%E6%95%B0%E6%8D%AE%E5%A4%84%E7%90%86%E3%80%81%E8%81%94%E7%9B%9F%E6%95%B0%E6%8D%AE%E5%8F%91%E5%B8%83%E7%AD%89%E4%B8%93%E9%A1%B9%E4%BB%BB%E5%8A%A1%E3%80%82

贡献指南

请参考贡献指南了解如何参与GENIE工具开发。

更多文档

项目详细文档请访问https://sage-bionetworks.github.io/Genie/%E3%80%82