blcdsdockerregistry/pipeval

PipeVal

镜像概述和主要用途

PipeVal是一款轻量级CLI工具，旨在验证生物信息学流程（如NF脚本/管道）中的输入参数。它可独立运行或通过Docker容器使用，提供文件和目录的多维度验证功能，同时支持校验和文件的生成，确保流程输入的准确性和可靠性。

核心功能和特性

功能概述

A. 验证输入文件和目录的以下特性：

文件验证（支持bam、vcf、fasta、bed、python文件）

• 给定路径下文件的存在性
• 文件扩展名类型
• 特定文件类型的有效性（如确认vcf文件为有效vcf格式）
• 校验和验证（若存在.md5或.sha512文件，生成并比较校验和）

目录验证（支持只读/读写权限检查）

• 给定路径下目录的存在性
• 可读性、可写性

B. 生成校验和文件并进行比较

输入类型

验证操作通过-t标签指定，未指定时默认使用file-input。

• 若输入类型为"file-input"，工具会自动匹配文件类型或仅检查存在性/可读性
• 若输入类型为校验和类型（如md5-gen），将基于输入文件路径创建新的校验和文件
• 所有输入类型均会检查存在性

依赖要求

独立使用时需安装以下依赖：

建议使用Docker容器以避免依赖管理问题。

使用场景和适用范围

• 生物信息学管道（如Nextflow）的输入验证
• 数据预处理阶段的文件完整性检查
• 自动化流程中的目录权限验证
• 批量文件校验和生成与验证

使用方法和配置说明

参数说明

必填参数

• path：一个或多个待验证或生成校验和的文件/目录路径

可选参数

• -t, --type：指定输入类型
• -h, --help：显示帮助信息并退出

运行方式

独立命令行工具运行

bash
validate -t file-bam path/to/file.bam

Docker交互会话运行

bash
docker run -it validate:1.0.0 /bin/bash
(bash): validate -t file-input path/to/file.bam

Nextflow流程中使用Docker

bash
# 示例请参考/example/目录或pipeline-align-DNA仓库

具体使用命令

文件特定验证

当前支持以下文件类型的特定验证：

显式检查单一文件类型：

bash
validate -t file-py path/to/file.py

（将file-py替换为输入类型表中的任何文件类型）

自动检测文件类型：

bash
validate -t file-input path/to/file.ext

工具会尝试自动检测文件类型并执行特定验证；若文件类型不支持，则仅进行存在性检查。

目录特定验证

检查目录权限：

bash
# 检查读写权限
validate -t directory-rw path/to/directory/

# 检查只读权限
validate -t directory-r path/to/directory/

校验和生成（测试版）

生成md5或sha512校验和文件：

bash
# 生成md5校验和
validate -t md5-gen path/to/file.ext

# 生成sha512校验和
validate -t sha512-gen path/to/file.ext

校验和文件将生成在path/to/file.ext.{checksum_ext}（如file.ext.md5）

注意：校验和比较功能仍在开发中（TBD）

输出说明

有效输入：

Input: path/to/input is valid

无效输入或错误：

Error: path/to/input Error Message

若输入无效，validate将调用sys.exit并抛出异常，可被Nextflow检测并相应处理。

参考资料

初始设计文档：[***]

许可证

作者：Gina Kim ()，Arpi Beshlikyan ()

PipeVal采用GNU通用公共许可证第2版授权。详见LICENSE文件了解GNU GPL许可证条款。

PipeVal是一款用于验证各种生物信息学管道输入和输出的工具。

版权所有 (C) 2020-2022 加州大学洛杉矶分校（"Boutros Lab"）。保留所有权利。

本程序是自由软件；您可以根据自由软件基金会发布的GNU通用公共许可证第2版（或更高版本）的条款重新分发和/或修改它。

本程序的分发旨在希望它有用，但不提供任何明示或暗示的担保，包括但不限于适销性和特定用途适用性的担保。有关更多详情，请参阅GNU通用公共许可证。