README.md

miiid-schema

Towards a Minimal Information about Intermicrobial Interaction Data schema

Website

https://FAIR-MI.github.io/miiid-schema

Repository Structure

• examples/ - example data
• project/ - project files (do not edit these)
• src/ - source files (edit these)
  • miiid_schema
    • schema -- LinkML schema (edit this)
    • datamodel -- generated Python datamodel
• tests/ - Python tests

Be sure to have a look at the CHANGELOG.md to know about the changes in the schema!

Developer Documentation

Interested in contributing to miiid-schema? Thanks, please make sure to read through CONTRIBUTING.md first.

Use the `make` command to generate project artefacts:

• make all: make everything
• make deploy: deploys site

Credits

The metadata schema is based on the metadata suggested in:

Pacheco, A. R., Pauvert, C., Kishore, D., & Segrè, D. (2022). Toward FAIR Representations of Microbial Interactions. MSystems, 7(5). https://doi.org/10.1128/msystems.00659-22.

The schema is implemented using LinkML and the linkml-project-cookiecutter.