slow5tools

COMMANDS

fast5toslow5 或 f2s:
将 FAST5 文件转换为 SLOW5/BLOW5 格式。

slow5tofast5 或 s2f:
将 SLOW5/BLOW5 文件转换为 FAST5 格式。

view:
查看 SLOW5/BLOW5 文件的内容或在不同的 SLOW5/BLOW5 格式和压缩之间进行转换。

index:
为 SLOW5/BLOW5 文件创建索引。

merge:
将多个 SLOW5/BLOW5 文件合并为一个文件。

cat:
快速连接相同读取组的 SLOW5/BLOW5 文件。

split:
将单个 SLOW5/BLOW5 文件分割成多个单独的文件。

get:
从 SLOW5/BLOW5 文件中检索指定读取 ID 的记录。

stats:
打印描述 SLOW5/BLOW5 文件的摘要统计信息。

skim:
快速浏览 SLOW5/BLOW5 文件并打印信号元数据。

quickcheck:
快速检查 SLOW5/BLOW5 文件是否完整。

degrade:
不可逆地降低并转换 SLOW5/BLOW5 文件。

Slow5tools 是一个用于转换 (FAST5 <-> SLOW5)、压缩、查看、索引和操作 SLOW5 格式数据的工具包。

fast5toslow5 (或 f2s)

slow5tools fast5toslow5 [OPTIONS] fast5_dir1 -d output_dir
slow5tools fast5toslow5 [OPTIONS] fast5_dir1 fast5_dir2 ... -d output_dir
slow5tools fast5toslow5 [OPTIONS] file1.fast5 file2.fast5 ... -d output_dir
slow5tools fast5toslow5 [OPTIONS] file.fast5 -o output.blow5
slow5tools fast5toslow5 [OPTIONS] file.fast5 -o output.slow5

将 FAST5 文件转换为 SLOW5/BLOW5 格式。输入可以是单个 FAST5 文件、多个 FAST5 文件的列表、包含多个 FAST5 文件的目录，或者是多个目录的列表。如果提供了目录，工具将递归搜索其中的 FAST5 文件（.fast5 扩展名）并将其转换为 SLOW5/BLOW5。对于输入目录中的每个多 FAST5 文件，将在输出目录中创建具有相同文件名的 SLOW5/BLOW5 文件（用 -d 指定）。如果提供了单个 FAST5 文件作为输入，将为转换过程中使用的每个进程创建单个 SLOW5/BLOW5 文件（用 -p 指定）。

注意：不建议在单个命令中将多 FAST5 和单 FAST5 文件混合运行 f2s。

• –to format_type:
  指定输出文件的格式。format_type 可以是 slow5 表示 SLOW5 ASCII，或者是 blow5 表示 SLOW5 二进制 (BLOW5) [默认值: blow5]。

• -d, --out-dir STR:
  指定输出目录的名称/位置（除非仅转换一个 FAST5 文件，否则为必需选项）。如果提供了名称，将在当前工作目录下创建目录。或者，可以提供有效的相对或绝对路径。为了防止数据覆盖，如果目录名称已存在且非空，程序将报错终止。

• -o, --output FILE:
  当仅转换一个 FAST5 文件时，-o 指定单个 FILE，输出数据将写入其中 [默认值: stdout]。与 -d 不兼容，并且可以根据文件扩展名自动检测输出格式。

• -c, --compress compression_type:
  指定用于 BLOW5 输出的压缩方法。compression_type 可以是 none 表示未压缩的二进制；zlib 表示基于 zlib（也称为 gzip 或 DEFLATE）的压缩；或者是 zstd 表示基于 Z-standard 的压缩 [默认值: zlib]。此选项仅对 BLOW5 有效。如果 slow5tools 构建时启用了 zstd 支持，则 zstd 才有效，默认情况下是关闭的。

• -s, --sig-compress compression_type:
  指定用于 BLOW5 输出的原始信号压缩方法。compression_type 可以是 none 表示未压缩的原始信号，svb-zd 表示使用 StreamVByte zig-zag delta 压缩原始信号，或者是 ex-zd（从 slow5tools v1.3.0 开始）表示异常编码 [默认值: svb-zd]。ex-zd 比 svb-zd 提供更好的压缩比率。此选项从 slow5tools v0.3.0 开始引入。请注意，记录压缩（上述 -c 选项）仍然应用于压缩信号之上。使用 svb-zd 信号压缩和 zstd 记录压缩类似于 ONT 的 vbz。zstd+svb-zd 比默认的 zlib+svb-zd 提供略小的文件大小和略好的性能，但可移植性较低。

• -p, --iop INT:
  指定转换过程中使用的 I/O 进程数 [默认值: 8]。增加 I/O 进程数会使 f2s 显著变快，特别是在具有 RAID 系统（多个磁盘）的 HPC 上，可以使用大量的进程数（例如，-p 64）。

• –lossless STR:
  在 FAST5 到 SLOW5 转换过程中保留辅助字段中的信息。STR 可以是 true 或 false [默认值: true]。这些信息通常不需要用于下游分析，并且可以可选地丢弃以减小文件大小。重要提示：生成的文件仅用于中间分析，不用于归档。您将无法将有损文件转换回 FAST5。

• -a, --allow:
  默认情况下 f2s 不接受包含多个唯一运行 ID 的单个多 fast5 文件或单个单 fast5 目录。当指定 -a 时 f2s 将允许单个多 fast5 文件或单 fast5 目录中存在多个唯一运行 ID。在这种情况下，所有 SLOW5/BLOW5 输出文件的头部将根据 f2s 看到的第一个运行 ID 确定。如果用户不需要原始运行 ID，则可以使用此选项通过单个命令转换来自不同样本的 FAST5 文件。

• –retain:
  在转换输出中保留与输入相同的目录结构（实验性）。

• -h, --help:
  打印帮助菜单。

merge

slow5tools merge [OPTIONS] file1.blow5 file2.blow5 -o output.blow5
slow5tools merge [OPTIONS] blow5_dir1 -o output.blow5
slow5tools merge [OPTIONS] blow5_dir1 blow5_dir2 -o output.blow5

将多个 SLOW5/BLOW5 文件合并为一个文件。输入可以是 SLOW5/BLOW5 文件的列表、包含多个 SLOW5/BLOW5 文件的目录，或者是多个目录的列表。如果提供了目录，工具将递归搜索其中的 SLOW5/BLOW5 文件（.slow5/blow5 扩展名）并合并它们的内容。如果检测到多个样本