支持上传文件提交到临床基因组分析平台(CGAP)。
submit-cgap的Python项目详细描述
说明
这是一个将某些类型的文件上载到CGAP的工具。在
最初支持的是“元数据包”,即Excel文件 (例如.xls或.xlsx文件) 与其他文件(例如.fastq.gz文件)一起提供。在
关于元数据捆绑包
注意
用作的Excel文件的格式 “元数据捆绑包”还没有文档化。 现在,您应该从获取模板文件开始 你在CGAP团队的联系人,然后根据需要定制。在
安装
安装此系统包括以下步骤:
- 创建、安装和激活虚拟环境。在
- 装诗
- 只有当您是开发人员时,才选择源存储库。 其他人没有可供选择的源存储库, 所以应该跳过这一步。在
- 如果您是最终用户,请执行“pip install submit_cgap”。 否则,请执行“make build”。在
- 设置~/.cgap-keys.json凭据文件。在
有关这些安装步骤的详细信息,请参阅 Installing SubmitCGAP。在
入门
一旦poetry完成将此库安装到虚拟环境中, 您应该可以访问submit-metadata-bundle命令。 有关其论点的帮助,请执行以下操作:
^{pr2}$然而,对于许多情况,只需具体说明就足够了 要上载的捆绑文件以及站点或 CGAP beanstalk环境。 例如:
submit-metadata-bundle mymetadata.xls
此命令应该执行所有操作,包括上载引用的文件 如果它们在同一个目录中。(将要求确认。)
要仅为验证而调用它,而不提交任何内容,请执行以下操作:
submit-metadata-bundle mymetadata.xls --validate_only
您可以通过执行以下操作来继续执行上载部分:
resume-uploads <uuid> --env <env>
或者:
resume-uploads <uuid> --server <server>
您可以通过执行以下操作分别上载单个文件:
upload-item-data <filename> --uuid <item-uuid> --env <env>
或者:
upload-item-data <filename> --uuid <item-uuid> --server <server>
其中,<item-uuid>是单个项的uuid,而不是元数据包。在
- 项目
标签: