NGS 管道引导程序
项目描述
固体
SOLIDA 是一种命令行解决方案,可促进 NGS 管道的可重复性和可移植性。它可以轻松组织基于 Snakemake 的工作流的部署、数据管理和执行。
安装
您可以从 PyPI 安装最新的稳定版本
pip install solida
要求
要运行 Solida,您的计算机中必须存在 Conda e Mamba。
要安装 Conda,请参阅https://conda.io/miniconda.html
要安装 Mamba,请参阅https://github.com/mamba-org/mamba
conda install -c conda-forge mamba
用法
检查版本:
solida -v
要列出所有启用的管道,数字
solida info
要检查管道和配置文件是否可用,请输入:
solida setup -l pipeline_label -p profile_label
在部署管道之前,您必须创建一个项目配置文件:
solida setup -l pipeline_label -p profile_label --create-profile
Solida 将创建一个名为profile_label.yaml的 yaml 文件到~/solida_profiles
编辑profile_label.yaml以匹配您的环境设置。
之后,将管道部署到 localhost 中:
solida setup -l pipeline_label -p profile_label --deploy
如果要将管道部署到远程主机,请添加以下参数:
solida setup -l pipeline_label -p profile_label --deploy --host remote_host
--remote-user username --connection ssh
其中:
--host是远程主机的主机名
--remote-user是远程主机中可用的用户名
--connection是要使用的连接类型
请注意,remote_user必须能够在没有密码的情况下通过 ssh 登录到remote_host (基于 SSH 密钥的身份验证)
执行工作流的脚本
Solida 提供了一个 bash 脚本run.project.sh来促进工作流程的执行。
run.project.sh [-h] [-s Snakefile] -c FILENAME [-w DIR] [-p "parameters"] --script to execute a snakemake workflow
where:
-h show this help text
-s path to a Snakefile different from the default one (Snakefile).
-c path to the snakemake's configuration file.
-w is the project's workdir label. Default is current timestamp.
-p snakemake parameters as "--rerun-incomplete --dryrun --keep-going --restart-time"
使用-s指定不同的 Snakefile。
如果你不给脚本一个 workdir 标签 ( -w ),一个以当前时间戳为标签的目录将被创建并用于收集结果。
选项-c是强制性的,并且必须是snakemake 配置文件的路径。
选项-p允许为脚本提供所有的 snakemake 参数(不要忘记用“”封装它们)。
项目详情
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。
源分布
内置分布
solida- 0.9.7.2 -py2.py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 0944541c7730d4e386621670fab16edb8a83ff6ac86ddb674db4047550620c97 |
|
MD5 | d116cdaba64c7d445bce0920f541f4dd |
|
布莱克2-256 | 8fe16ad618dbe44da38eb162f25a252c6353aeb33bf600ad7c15292bc2e321ed |