面向python的ngs管道原型工具
zippy-pipeline的Python项目详细描述
#zippy
zippy
pipeline
pipeline
prototype
系统是一个功能强大、易于使用的ngs管道原型系统，包括电池。zippy帮助您创建基于json的管道规范，然后使用该规范执行一系列管道阶段，无需用户编写代码。
在
-使用我们的超模块化系统添加新模块，然后可以与其他模块连接
-在10分钟或更短时间内创建自定义管道
zippy包括各种模块，包括：
-bcl2fastq
-bwa
-picard alignment stats
-rsem
-macs
-bam subsampling
（请参见[此处]模块的完整列表（https://github.com/illumina/zippy/wiki/zippy modules））。
目前，只支持cpython 2.7。zippy还需要几个python模块。为了使生活更容易，Zippy的可执行版本是可用的（请参阅发行版页面！）.
从源代码运行zippy
如果要从源代码运行zippy，需要注意两件事。
-必须使用cpython 2.7
-必须安装"commentjson"和"pyflow"模块（注意：pyflow不在pypi中，但是可以在这里找到（https://github.com/illumina/pyflow）。您可以选择安装包"meta"，如果您没有某些导入模块（例如，仅.pyc文件）的源，则可以提高make_params中参数的覆盖率。
-运行测试文件make_params_test.py并查看是否正常！
使用zippy:
0。使用"pip install--process dependency links zippy pipeline"安装zippy
1。制作一个proto工作流文件。
proto工作流是一个非常简单的json文件，它按照您想要的顺序列出了您想要的管道阶段。这里有一个简单的原型工作流程，我在一些rna序列应用程序中使用：
``
{
"stages"：["bcl2fastq"，"rsem"]
}
```
是的，就是这样。
2.编译proto工作流
execute'python-m zippy.make_params my_proto.json my_params.json'
3。填空和/或连接点
打开my_params.json并填写当前为空的所有参数。
4.快跑
快跑，执行"python-m zippy.zippy my_params.json"
**更多信息在git wiki上。**
v2.1.2（2018年11月13日）
-改进bwa模块（kwu）
-添加了复制文件夹
v2.1.1（6/14/2018）
-在本地模式下执行的改进和其他小修复
v2.1.0（4/11/2018）
-第一次公开发布
-参数2.0。支持子工作流、参数嵌套和环境。
-支持通过奇点运行Docker容器
-更好的可选参数支持。现在，您可以创建define廑optional s（self）函数，它返回可选参数的默认值映射。
-新阶段（nirvana变量注释、minimap2对齐器、引物二聚体检测）
-新单元测试
-已知错误更少
v2.0.0（2/14/2018）
就在这里！Release2.0启动了Zippy-as-a-package。现在您可以pip安装zippy，一旦这样做了，就将其作为python-m zippy.zippy运行。此外，您可以从任何地方导入zippy并使用api。特别感谢李伟的工作。另外，我们终于转向语义化版本控制了。
-zippy as a package
-api接口应该完成
-更好的docker支持（现在可以支持docker pull）
-几个小错误修复
-小文档改进
v1.9{6}（12/7/2017）
-临时zippy api（函数名不是最终的接口）
-删除了几个外部依赖项
-参数检测现在默认为inspect模块，而不是元模块（即，当可能）
-支持本地运行而不是在sge上运行
-现在可以为每个阶段和全局设置内存/核心需求
-新阶段（允许您删除中间输出，将bam转换为fastq，以及使用bloom过滤器减少样本量）
-datarunner改进：现在可以从样本表加载样本列表，现在可以手动将文件名映射到zippy类型
-更好地支持外部文件中的模块（make_params现在完全支持它们）
-但错误更少！或者至少…不同的错误。
v1.99999（8/30/17）
-支持外部模块（外部代码中定义的运行程序）
-大量的工作流改进（几乎所有工作都通过参数传递，新的bcl2fastq和bwa工作流）
-新工作流（dna/rna qc，edger和salmon）
-新的帮助系统（运行"python zippy.py--help"）
v1.9999（5/1/17）
-单元测试
-参数文件中的通配符
-合并阶段
-支持可选参数
v1.999（2/16/17）
-任意阶段链接
-更多阶段
-更少Bugs
v1.99
Zippy的第一个端到端版本
您可以在http://www.apache.org/licenses/license-2.0
上获取许可证副本，除非适用法律要求或书面同意，否则根据许可证分发的软件是按"原样"分发的，无任何明示或暗示的保证或条件。请参阅许可证，了解该许可证下管理权限和限制的特定语言。
zippy
pipeline
pipeline
prototype
系统是一个功能强大、易于使用的ngs管道原型系统，包括电池。zippy帮助您创建基于json的管道规范，然后使用该规范执行一系列管道阶段，无需用户编写代码。
在
-使用我们的超模块化系统添加新模块，然后可以与其他模块连接
-在10分钟或更短时间内创建自定义管道
zippy包括各种模块，包括：
-bcl2fastq
-bwa
-picard alignment stats
-rsem
-macs
-bam subsampling
（请参见[此处]模块的完整列表（https://github.com/illumina/zippy/wiki/zippy modules））。
目前，只支持cpython 2.7。zippy还需要几个python模块。为了使生活更容易，Zippy的可执行版本是可用的（请参阅发行版页面！）.
从源代码运行zippy
如果要从源代码运行zippy，需要注意两件事。
-必须使用cpython 2.7
-必须安装"commentjson"和"pyflow"模块（注意：pyflow不在pypi中，但是可以在这里找到（https://github.com/illumina/pyflow）。您可以选择安装包"meta"，如果您没有某些导入模块（例如，仅.pyc文件）的源，则可以提高make_params中参数的覆盖率。
-运行测试文件make_params_test.py并查看是否正常！
使用zippy:
0。使用"pip install--process dependency links zippy pipeline"安装zippy
1。制作一个proto工作流文件。
proto工作流是一个非常简单的json文件，它按照您想要的顺序列出了您想要的管道阶段。这里有一个简单的原型工作流程，我在一些rna序列应用程序中使用：
``
{
"stages"：["bcl2fastq"，"rsem"]
}
```
是的，就是这样。
2.编译proto工作流
execute'python-m zippy.make_params my_proto.json my_params.json'
3。填空和/或连接点
打开my_params.json并填写当前为空的所有参数。
4.快跑
快跑，执行"python-m zippy.zippy my_params.json"
**更多信息在git wiki上。**
v2.1.2（2018年11月13日）
-改进bwa模块（kwu）
-添加了复制文件夹
v2.1.1（6/14/2018）
-在本地模式下执行的改进和其他小修复
v2.1.0（4/11/2018）
-第一次公开发布
-参数2.0。支持子工作流、参数嵌套和环境。
-支持通过奇点运行Docker容器
-更好的可选参数支持。现在，您可以创建define廑optional s（self）函数，它返回可选参数的默认值映射。
-新阶段（nirvana变量注释、minimap2对齐器、引物二聚体检测）
-新单元测试
-已知错误更少
v2.0.0（2/14/2018）
就在这里！Release2.0启动了Zippy-as-a-package。现在您可以pip安装zippy，一旦这样做了，就将其作为python-m zippy.zippy运行。此外，您可以从任何地方导入zippy并使用api。特别感谢李伟的工作。另外，我们终于转向语义化版本控制了。
-zippy as a package
-api接口应该完成
-更好的docker支持（现在可以支持docker pull）
-几个小错误修复
-小文档改进
v1.9{6}（12/7/2017）
-临时zippy api（函数名不是最终的接口）
-删除了几个外部依赖项
-参数检测现在默认为inspect模块，而不是元模块（即，当可能）
-支持本地运行而不是在sge上运行
-现在可以为每个阶段和全局设置内存/核心需求
-新阶段（允许您删除中间输出，将bam转换为fastq，以及使用bloom过滤器减少样本量）
-datarunner改进：现在可以从样本表加载样本列表，现在可以手动将文件名映射到zippy类型
-更好地支持外部文件中的模块（make_params现在完全支持它们）
-但错误更少！或者至少…不同的错误。
v1.99999（8/30/17）
-支持外部模块（外部代码中定义的运行程序）
-大量的工作流改进（几乎所有工作都通过参数传递，新的bcl2fastq和bwa工作流）
-新工作流（dna/rna qc，edger和salmon）
-新的帮助系统（运行"python zippy.py--help"）
v1.9999（5/1/17）
-单元测试
-参数文件中的通配符
-合并阶段
-支持可选参数
v1.999（2/16/17）
-任意阶段链接
-更多阶段
-更少Bugs
v1.99
Zippy的第一个端到端版本
您可以在http://www.apache.org/licenses/license-2.0
上获取许可证副本，除非适用法律要求或书面同意，否则根据许可证分发的软件是按"原样"分发的，无任何明示或暗示的保证或条件。请参阅许可证，了解该许可证下管理权限和限制的特定语言。
欢迎加入QQ群-->： 979659372
