tengfei/testenv

sevenbridges-r

https://travis-ci.org/sbg/sevenbridges-r.svg?branch=master](https://travis-ci.org/sbg/sevenbridges-r)
https://ci.appveyor.com/api/projects/status/github/sbg/sevenbridges-r?branch=master&svg=true](https://ci.appveyor.com/project/road2stat/sevenbridges-r)
https://www.bioconductor.org/shields/years-in-bioc/sevenbridges.svg](https://bioconductor.org/packages/release/bioc/html/sevenbridges.html#since)
https://www.bioconductor.org/shields/downloads/sevenbridges.svg](https://bioconductor.org/packages/stats/bioc/sevenbridges/)
https://img.shields.io/docker/pulls/sevenbridges/sevenbridges-r.svg](https://hub.docker.com/r/sevenbridges/sevenbridges-r/)

概述

sevenbridges-r是一个R/Bioconductor包，提供Seven Bridges Platform、Cancer Genomics Cloud（CGC）和Cavatica公共API的接口。

Seven Bridges Platform是基于云的生物信息学分析环境，为团队提供数据存储、分析及联合解读的中心枢纽；CGC由Seven Bridges支持，是美国国家癌症研究所资助的试点系统，用于整合大规模基因组数据集与计算资源；Cavatica专注于儿科数据，加速研究发现。

目录

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

安装

检查R版本

在R中运行以下命令检查版本：

r
R.version.string  

若未使用最新版本，请按https://www.bioconductor.org/install/#install-R%E5%8D%87%E7%BA%A7%E3%80%82

Bioconductor - 稳定版

推荐大多数用户使用：

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

Bioconductor - 开发版

适用于开发场景：

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

最新开发版本

从GitHub安装（需devtools包）：

bash
apt-get update  
apt-get install libcurl4-gnutls-dev libssl-dev pandoc pandoc-citeproc  

r
install.packages("devtools")  
install.packages("BiocManager")  
install.packages("readr")  

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客户端

提供面向对象API，支持项目、文件、任务等操作：

r
# 获取项目  
p <- a$project("demo")  
# 删除文件  
p$file("sample.tz")$delete()  
# 上传文件夹  
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各平台（CGC、AWS/GCP上的Platform）。

CWL工具接口

在R中描述CWL工具并导出：

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")),  
  outputs = output(id = "random", glob = "output.txt")  
)  
rbx$toJSON(pretty = TRUE)  

IDE Docker镜像

启动RStudio和Shiny服务器：

shell
docker run -d -p 8787:8787 -p 3838:3838 --name rstudio_shiny_server sevenbridges/sevenbridges-r  

挂载文件系统：

shell
docker run --privileged -d -p 8787:8787 -p 3838:3838 --name rstudio_shiny_server sevenbridges/sevenbridges-r  

访问RStudio：http://<IP>:8787/，Shiny应用：http://<IP>:3838/users/<username>/<app_dir>。

常见问题

• Q：是否支持API v1？
  A：不支持，仅支持API v2+。
• Q：支持CWL版本？
  A：支持draft 2，正在开发draft 3。
• Q：有Python绑定吗？
  A：有，官方客户端见https://github.com/sbg/sevenbridges-python%E3%80%82

贡献

请在https://github.com/sbg/sevenbridges-r/issues%E6%8F%90%E4%BA%A4%E5%8F%8D%E9%A6%88%EF%BC%8C%E6%88%96%E5%88%9B%E5%BB%BAhttps://github.com/sbg/sevenbridges-r/pulls%E3%80%82%E8%B4%A1%E7%8C%AE%E8%80%85%E9%9C%80%E7%AD%BE%E7%BD%B2%E3%80%8ASeven Bridges Contributor Agreement》。

版权

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