17 个版本

0.4.6 2022年9月26日
0.4.4 2022年2月21日
0.4.0 2020年12月1日
0.3.0 2020年8月6日
0.2.2 2019年7月23日

351科学

47 每月下载

MIT 许可证

385KB
9K SLoC

fastobo-validator Star me

OBO 产品的错误验证工具。

Actions License Source Binaries Crate Changelog GitHub issues

概述

fastobo-validator 是一个命令行工具,用于验证格式版本 1.4 的 OBO 文件是否符合最新的规范

设置

fastobo-validator 以预构建的二进制文件形式分发到以下平台

只需下载存档,将 fastobo-validator 二进制文件解压到您的 $PATH 中的某个位置。对于其他操作系统(尤其是 Windows),您需要从源代码构建二进制文件。请确保已安装 Rust 编译器(检查安装方法),然后只需运行 cargo install fastobo-validator 将二进制文件安装到您的 $CARGO_HOME 文件夹中。

验证

必需

语法

OBO 格式版本 1.4 的语法比格式版本 1.2 更为严格,但由现代工具(如 ROBOT)生成的文件应该已经符合此版本。

基数

某些子句(如 namedef)在框架内只能出现固定次数。 fastobo-validator 将检查输入文档中这些子句出现的次数。

可选

ISBN 验证(-I / --ISBN

ISBN标识符包含一个验证位,可以用于验证给定的代码而无需查询外部数据库。启用此验证检查将处理所有以ISBN为前缀的有效ISBN标识符。它不会检查以ISBN10ISBN13为前缀的标识符。

帧重复(-d / --duplicates

虽然OBO语法和语义没有禁止,但在OBO文档中存在相同ID的帧通常是一个错误。使用此标志验证输入中所有帧都有一个唯一的标识符。

废弃条款(-O / --obsoletion

某些条款,如considerreplaced_by,只能在已废弃的实体的框架中出现。使用此标志检查是否确实如此。

全部检查(--all

启用所有可选验证。请注意,在自动化环境(如CI工作流程)中使用此参数意味着,如果您在添加额外检查后更新了fastobo-validator,则您的文件可能无法通过验证。建议您仅在自行运行二进制文件时使用此标志。

用法

只需运行二进制文件针对一个或多个OBO文件

$ fastobo-validator go.obo

验证器将解析并验证每个OBO产品,并在检测到任何错误时返回非空错误代码,并为每个错误显示一个小报告。

反馈

发现了一个错误?有一个增强请求吗?如果您需要报告或询问某些内容,请访问项目的GitHub问题跟踪器。如果您正在填写有关错误的报告,请尽可能包含有关问题的信息,并尝试在简单、易于复现的情况下重现相同的错误。

关于

该项目是由Martin LarraldeBBOP团队劳伦斯伯克利国家实验室的硕士学位实习期间开发的,在Chris Mungall的指导下。请引用此项目为

Larralde M. 开发Python和Rust库以改进本体生态系统 [版本1;未同行评审]。 F1000Research 2019,8(ISCB Comm J):1500(海报)(https://doi.org/10.7490/f1000research.1117405.1

依赖关系

~5–16MB
~164K SLoC