PDBe-KB Guidelines for Collaborating
Protein Data Bank in Europe - Knowledge Base (PDBe-KB) is a community-driven resource managed by the PDBe team, collating functional annotations and predictions for structure data in the PDB archive. PDBe-KB is a collaborative effort between PDBe and a diverse group of bioinformatics resources and research teams. This document outlines the framework for contributing to the PDBe-KB collaborative resource and the services PDBe-KB agrees to provide.
Terms of collaboration
- The infrastructure for data deposition and retrieval will be maintained by PDBe-KB
- Data exchange format schema(s) will be maintained by PDBe-KB
- The schema will evolve in consultation with collaborating partners
- PDBe-KB will provide programmatic access to expose contributed annotations
- PDBe-KB will link back to the original collaborating partners resource, attributing credit for their contributions
- PDBe-KB will maintain an open-access library of reusable data visualisation components
- The data contributed to PDBe-KB by collaborating partners will be free from any restrictions on distribution and re-use
- The partners are responsible for the quality of the data they contribute
- Protocols for data generation must be published in peer-reviewed publications
- In case of predicted/calculated annotations, the contributing partner makes a commitment of
depositing data at least once a year: e.g., to provide annotations for newer PDB entries and/or
update the existing annotations when the underlying algorithms change significantly.
- Manually curated annotations may be exempt from this condition on a case-by-case basis
- Depositors can change/update/delete their entries at any time
General Data Protection Regulation (GDPR) notice
Collaborating partners have to agree to the PDBe-KB GDPR notice before registering a data deposition account. The privacy notice is available here
Technical appendix (data collection)
Most data, and in particular residue-level annotations will be deposited using the PDBe-KB deposition system. The deposition system consists of the following components:
PDBe-KB JSON specification
A common JSON schema is defined to capture residue-level annotations, and is hosted at https://github.com/funpdbe-consortium/funpdbe_schema. Contributing partners have to comply with the JSON specification in order to deposit data via the FunPDBe deposition system.
A Python 3 client is provided for the contributors to parse input JSON files, validate them against the FunPDBe schema, and push them to the deposition API. The client is available for download at: https://github.com/funpdbe-consortium/funpdbe-client Contributing partners have to register an account in order to obtain credentials and permissions for data deposition. Registration is accessible at: https://www.ebi.ac.uk/pdbe/funpdbe/deposition/register
Deposition API and database
The deposition client communicates with the deposition API hosted by PDBe-KB. This API accepts the validated JSONs, performs additional mandatory validations, and loads the data into the MySQL back-end database.