在targetvalidation.org进行证据验证
opentargets-validator的Python项目详细描述
opentargets验证器
证据字符串验证程序。
目的
此工具旨在验证每行有一个json对象的json文件。这是data sources所要求的格式,它为我们的目标疾病关联提供了证据。
验证器将检查json模式中定义的预期结构,该模式必须通过--schema
参数提供。
请注意,这是一个not通用json验证器,使用“漂亮的打印”json将导致错误。
如何安装
最简单的方法是使用pip:
pip install -U opentargets-validator
它同时支持Python2和Python3。
如何使用
您有两个选项:
- 将文件名或url作为位置参数传递
- 从stdin(例如壳管)读取
从stdin中读取
cat file.json | opentargets_validator --schema https://raw.githubusercontent.com/opentargets/json_schema/1.6.0/opentargets.json
从位置参数读取
这可以自动解压缩gzip文件。将通过文件名检测压缩,例如以.json.gz
结尾。
可接受路径的示例如下:
- https://file/location/name.json
- https://file/location/name.json.gz
- file://relative/local/file.json
- file:///absolute/file.json
- 位置/file.json
opentargets_validator --schema https://raw.githubusercontent.com/opentargets/json_schema/1.6.0/opentargets.json https://where/myfile/is/located.json
注
过去有一个^ {< CD3>}参数,当某些错误发生时,它可以用于早期退出。这已经不受支持,而且随着并行化的改进,在实践中几乎没有必要。
通过计算unique_association_fields
字段的散列检查证据行的唯一性。这可以在验证器中使用--hash
参数来完成。
如何开发
在virtualenv中,您可以使用以下命令安装:
pip install -e .[dev]
您可以使用以下命令运行测试:
pytest --cov=opentargets_validator --cov-report term tests/ --fulltrace
这个存储库有Travis integration和CodeCov integration。
发行版通过github标签中的travis自动放在PyPI上。