Skip to main content

matrix-validator

Project description

MATRIX validator

A validation tool for KG edges and nodes in KGX format.

Users

Install the validator:

pip install matrix-validator

Run the validator:

matrix-validator python \
		--report-dir tmp/ \
		--edges abc_edges.tsv \
		--nodes abc_nodes.tsv

Currently available options for validator are "pandera", "python" and "polars".

Getting started for Developers

  1. Make sure you have poetry installed
  2. Run make install to install the poetry environment
  3. Run make run_small_tests to see if it worked

The tool is currently divided in the following files (basic layout):

  • src/matrix_validator/cli.py contains all CLI methods (click-based) and should not contain any code other than CLI boilerplate (in particular no IO)
  • src/matrix_validator/validator.py contains the abstract validation class.
  • src/matrix_validator/datamodels.py contains the edge and nodes schemas.
  • src/matrix_validator/util.py contains any utility methods that we might need.
  • We currently experiment with a number of different implementations:
    • src/matrix_validator/validator_polars.py: A very efficient pure polars implementation.
    • src/matrix_validator/validator_purepython.py: A pure python implementation
    • src/matrix_validator/validator_schema.py: A schema-based validation approach based on LinkML generated pandera schemas.

Acknowledgements

This cookiecutter project was developed from the monarch-project-template template and will be kept up-to-date using cruft.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

matrix_validator-0.0.6.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

matrix_validator-0.0.6-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file matrix_validator-0.0.6.tar.gz.

File metadata

  • Download URL: matrix_validator-0.0.6.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for matrix_validator-0.0.6.tar.gz
Algorithm Hash digest
SHA256 17b14c066d3da74bfff87514fa9f1d261bcd09deb30ab0e7129801718922229f
MD5 15a430c268e0689d65d84ff58f9b10b1
BLAKE2b-256 0340499b9a2af224f887bca71947bccf342365d76e73595c726339b258be4ff4

See more details on using hashes here.

File details

Details for the file matrix_validator-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for matrix_validator-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6eedda6e7428ab685a7b09df3505eaa91883018eea4005f884262c38a084f2b0
MD5 785b931a7dbee10d3755d28bf8e4d772
BLAKE2b-256 60ab336cda28ad5e9d3d4124d7032734e6bfb2a43915a39a5541e182db922bef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page