模拟重复纳米孔实验。
taeper的Python项目详细描述
===
taeper
==
模拟重复纳米孔实验。
图片::https://img.shields.io/pypi/v/taeper.svg
:目标:https://pypi.python.org/pypi/taeper
…图片::https://img.shields.io/travis/mbhall88/taeper.svg
:目标:https://travis ci.org/mbhall88/taeper
…图片::https://readthedocs.org/projects/taeper/badge/?version=latest
:目标:https://taeper.readthedocs.io/en/latest/?badge=latest
:alt:documentation status
此工具专为开发用于实时分析牛津纳米孔测序数据的工具和应用程序的任何人而设计。使用非常简单。给定一个包含"fast5"文件的目录"`a`"和一个目标目录"`b`",此工具将文件从"a`"复制到"`b`",复制的顺序和时间与实际实验中放入reads文件夹的顺序和时间相同。它还将保持当前的目录结构。
"幸运的是,有一个可选的
缩放因子可以加快进程(``--scale``)。
安装
===
这是一个**python3专用**包。
要安装,只需运行
代码块:bash
pip3 install taeper
taeper--help
usage
==
``taeper`用于模拟在minion运行中生成的fast5文件的顺序和时间。给它一个输入目录,它将收集该目录下所有fast5文件(包括子目录)的名称。
它收集每次读取完成排序的时间信息,并为所有文件创建排序索引。在这个索引中,第一个文件是第一个排序的文件,依此类推。附加到每个文件路径的是一个延迟时间,``t``以秒为单位。
这指定读取完成的排序``t``在它前面的排序后的秒数
。这样"taeper"就可以重新运行fast5文件存放方面的实验。然后,它将这些文件移动到指定的
输出目录中,并重新创建任何子目录结构(例如pass或fail
文件夹)。
代码块::bash
taeper--input_dir path/to/reads--output some/place
这将把"path/to/reads"中的所有fast5文件复制到
中的"some/place"。
这就需要。在这种情况下,您可以使用scale选项。代码块::bash
taeper--input_dir path/to/reads--output some/place--scale 100
这将比重新运行实验快100倍。
具有时间延迟的文件顺序的索引
文件存储在名为"taeper_index.npy"的文件中。
请记住,索引中的文件路径与在其中生成的工作目录相关。
如果只想索引而不复制,可以执行
。代码块::bash
taeper--input_dir path/to/reads--dump_index experiment_index.npy
``--dump_index``还允许您指定一个
名称,而不是索引的默认名称。
代码块::bash
**完全使用**
代码块::bash
taeper--help
用法:taeper[-h]-i输入目录[--索引索引][-o输出][--scale scale]
[-d转储目录][--no_索引][--log_level{0,1,2,3,4,5}]
[--no_progress_bar]
如果pass和fail
输出目录中不存在文件夹,则如果在fast5文件的
文件路径中检测到,则将创建这些文件夹。
文件所在的目录。
--索引索引提供一个预先构建的索引文件以跳过索引。请注意,索引文件中的路径在生成时相对于当前工作目录。
-o output,--output
要将文件复制到的目录。如果未指定,则将
仅生成索引文件。
--缩放计时的缩放量。即10的刻度将
存储比生成的读数大10倍的数据。
(默认值=1.0)
-d dump_index,--dump_index dump_index
将索引另存为的路径。默认值是当前工作目录中的"taeper_index.npy"
。注意:索引
中的路径是相对于当前工作目录的。
--没有索引不会将索引列表写入文件。这意味着它需要在每次运行时重新生成此数据集。
--日志级别{0,1,2,3,4,5}
日志级别。0表示无,5表示调试。
默认值为4,将报告信息、警告、错误,
和关键信息。
--没有进度条不显示进度条。
尽管如此,我已经用最新的表单测试了这个程序,它运行得很好。如果"taeper"无法读取文件或确定其完成时间,则控制台上将显示日志记录警告。
-
*免费软件:MIT许可证
*文档:https://taeper.readthedocs.io。
credits
-
使用Cookiecutter和"audreyr/Cookiecutter pypackage"项目模板。_ Cookiecutter:https://github.com/audreyr/Cookiecutter
。_` audreyr/cookiecutter pypackage`:https://github.com/audreyr/cookiecutter pypackage
==
==
==history
==
<0.1.0(2018-03-26)
----
*在pypi上首次发布。
taeper
==
模拟重复纳米孔实验。
图片::https://img.shields.io/pypi/v/taeper.svg
:目标:https://pypi.python.org/pypi/taeper
…图片::https://img.shields.io/travis/mbhall88/taeper.svg
:目标:https://travis ci.org/mbhall88/taeper
…图片::https://readthedocs.org/projects/taeper/badge/?version=latest
:目标:https://taeper.readthedocs.io/en/latest/?badge=latest
:alt:documentation status
此工具专为开发用于实时分析牛津纳米孔测序数据的工具和应用程序的任何人而设计。使用非常简单。给定一个包含"fast5"文件的目录"`a`"和一个目标目录"`b`",此工具将文件从"a`"复制到"`b`",复制的顺序和时间与实际实验中放入reads文件夹的顺序和时间相同。它还将保持当前的目录结构。
"幸运的是,有一个可选的
缩放因子可以加快进程(``--scale``)。
安装
===
这是一个**python3专用**包。
要安装,只需运行
代码块:bash
pip3 install taeper
taeper--help
usage
==
``taeper`用于模拟在minion运行中生成的fast5文件的顺序和时间。给它一个输入目录,它将收集该目录下所有fast5文件(包括子目录)的名称。
它收集每次读取完成排序的时间信息,并为所有文件创建排序索引。在这个索引中,第一个文件是第一个排序的文件,依此类推。附加到每个文件路径的是一个延迟时间,``t``以秒为单位。
这指定读取完成的排序``t``在它前面的排序后的秒数
。这样"taeper"就可以重新运行fast5文件存放方面的实验。然后,它将这些文件移动到指定的
输出目录中,并重新创建任何子目录结构(例如pass或fail
文件夹)。
代码块::bash
taeper--input_dir path/to/reads--output some/place
这将把"path/to/reads"中的所有fast5文件复制到
中的"some/place"。
这就需要。在这种情况下,您可以使用scale选项。代码块::bash
taeper--input_dir path/to/reads--output some/place--scale 100
这将比重新运行实验快100倍。
具有时间延迟的文件顺序的索引
文件存储在名为"taeper_index.npy"的文件中。
请记住,索引中的文件路径与在其中生成的工作目录相关。
如果只想索引而不复制,可以执行
。代码块::bash
taeper--input_dir path/to/reads--dump_index experiment_index.npy
``--dump_index``还允许您指定一个
名称,而不是索引的默认名称。
代码块::bash
**完全使用**
代码块::bash
taeper--help
用法:taeper[-h]-i输入目录[--索引索引][-o输出][--scale scale]
[-d转储目录][--no_索引][--log_level{0,1,2,3,4,5}]
[--no_progress_bar]
如果pass和fail
输出目录中不存在文件夹,则如果在fast5文件的
文件路径中检测到,则将创建这些文件夹。
文件所在的目录。
--索引索引提供一个预先构建的索引文件以跳过索引。请注意,索引文件中的路径在生成时相对于当前工作目录。
-o output,--output
要将文件复制到的目录。如果未指定,则将
仅生成索引文件。
--缩放计时的缩放量。即10的刻度将
存储比生成的读数大10倍的数据。
(默认值=1.0)
-d dump_index,--dump_index dump_index
将索引另存为的路径。默认值是当前工作目录中的"taeper_index.npy"
。注意:索引
中的路径是相对于当前工作目录的。
--没有索引不会将索引列表写入文件。这意味着它需要在每次运行时重新生成此数据集。
--日志级别{0,1,2,3,4,5}
日志级别。0表示无,5表示调试。
默认值为4,将报告信息、警告、错误,
和关键信息。
--没有进度条不显示进度条。
尽管如此,我已经用最新的表单测试了这个程序,它运行得很好。如果"taeper"无法读取文件或确定其完成时间,则控制台上将显示日志记录警告。
-
*免费软件:MIT许可证
*文档:https://taeper.readthedocs.io。
credits
-
使用Cookiecutter和"audreyr/Cookiecutter pypackage"项目模板。_ Cookiecutter:https://github.com/audreyr/Cookiecutter
。_` audreyr/cookiecutter pypackage`:https://github.com/audreyr/cookiecutter pypackage
==
==
==history
==
<0.1.0(2018-03-26)
----
*在pypi上首次发布。