tengfei/sevenbridges

sevenbridges-r

https://www.bioconductor.org/packages/release/bioc/html/sevenbridges.html · https://www.bioconductor.org/packages/devel/bioc/html/sevenbridges.html · https://github.com/sbg/sevenbridges-r

概述

本Docker镜像为sevenbridges R包的基础镜像。sevenbridges-r是一个基于R/Bioconductor的包，提供Seven Bridges Platform、Cancer Genomics Cloud（CGC）和Cavatica公共API的接口。这些平台均为云端生物信息学分析环境，支持数据存储、分析及协作：

• Seven Bridges Platform：用于团队存储、分析和解读生物信息数据的云端平台。
• Cancer Genomics Cloud（CGC）：由美国国家癌症研究所资助的云端计算环境，提供TCGA等大规模基因组数据集的访问。
• Cavatica：专注于儿科数据的分析与共享平台，由费城儿童医院与Seven Bridges合作开发。

目录

• 概述
• 安装
  • 检查R版本
  • Bioconductor - 稳定版
  • Bioconductor - 开发版
  • 最新开发版本
• 功能
  • 灵活的认证方式
  • 完整的API客户端
  • 任务监控
  • 批量任务支持
  • 跨环境支持
  • Common Workflow Language工具接口
  • 工具与工作流工具
• 教程
• IDE Docker镜像
• 常见问题
• 活动
• 贡献
• 版权

安装

检查R版本

首先在R中检查版本：

r
R.version.string

若版本不是最新稳定版，请参考https://www.bioconductor.org/install/#install-R升级。

Bioconductor - 稳定版

推荐大多数用户使用稳定版：

r
install.packages("BiocManager")
BiocManager::install("sevenbridges")

Bioconductor - 开发版

适用于开发人员或使用R/Bioconductor开发版的用户：

r
install.packages("BiocManager")
BiocManager::install("sevenbridges", version = "devel")

最新开发版本

从GitHub安装最新功能：

r
install.packages("devtools")
# Ubuntu系统需先安装依赖：apt-get install libcurl4-gnutls-dev libssl-dev pandoc pandoc-citeproc
devtools::install_github(
  "sbg/sevenbridges-r",
  repos = BiocManager::repositories(),
  build_vignettes = TRUE, dependencies = TRUE
)

功能

灵活的认证方式

支持直接认证、环境变量认证和配置文件认证：

r
# 直接认证
a <- Auth(token = "your_token", platform = "cgc")
# 环境变量认证
sbg_set_env(token = "your_token", url = "https://cgc-api.sbgenomics.com/v2")
a <- Auth(from = "env")

完整的API客户端

提供用户、项目、文件、任务等资源的操作接口：

r
# 获取项目
p <- a$project("demo")
# 上传文件
p$upload("folder_path", metadata = list(platform = "Illumina"))

任务监控

支持任务状态钩子，如任务完成时自动下载结果：

r
setTaskHook("completed", function() { tsk$download("~/Downloads") })
tsk$monitor()

批量任务支持

支持按项目或元数据批量创建任务：

r
# 按项目批量
tsk <- p$task_add(
  name = "RNA DE report batch",
  app = rna.app$id,
  batch = batch(input = "bamfiles"),
  inputs = list(bamfiles = bamfiles.in, design = design.in)
)

跨环境支持

兼容Seven Bridges Platform、CGC等不同云端环境。

Common Workflow Language工具接口

支持用R描述CWL工具并导出为JSON/YAML：

r
rbx <- Tool(
  id = "runif",
  hints = requirements(docker(pull = "rocker/r-base"), cpu(1), mem(2000)),
  baseCommand = "Rscript runif.R",
  inputs = list(input(id = "number", type = "integer"))
)
rbx$toJSON(pretty = TRUE)

IDE Docker镜像

启动RStudio和Shiny服务器：

shell
docker run -d -p 8787:8787 -p 3838:3838 --name rstudio_shiny_server docker.xuanyuan.run/sevenbridges/sevenbridges-r
# 挂载文件系统（需fuse权限）
docker run --privileged -d -p 8787:8787 -p 3838:3838 --name rstudio_shiny_server docker.xuanyuan.run/sevenbridges/sevenbridges-r

访问RStudio：http://<IP>:8787（默认用户rstudio，密码rstudio）；Shiny应用：http://<IP>:3838/users/rstudio/<app_dir>。

常见问题

• Q：是否支持Seven Bridges API v1？
  A：不支持，仅支持API v2+，v1用户请使用sbgr包。
• Q：支持哪些CWL版本？
  A：支持draft 2，正在开发draft 3支持。
• Q：有Python客户端吗？
  A：有，官方Python客户端见https://github.com/sbg/sevenbridges-python。

贡献

请在https://github.com/sbg/sevenbridges-r/issues提交bug报告或PR，贡献前需签署贡献者协议。

版权

© 2018 Seven Bridges Genomics, Inc. 保留所有权利。
本项目基于Apache License 2.0许可。