This repository stores the current and previous versions of the FAIRe metadata checklist, along with a detailed version history.
Field definitions are in slots/ (one YAML per term). The single .xlsx in latest_checklist/ is the authoritative checklist.
The pipeline builds the LinkML schema from the checklist Excel and slots; after that, you regenerate the Excel template from the schema — that’s what researchers use.
From repo root. Dependencies: pip install openpyxl pyyaml pandas ruamel.yaml
| What to run | What it does |
|---|---|
doc_gen_scripts/build_enums_from_checklist.py |
Reads latest_checklist/*.xlsx + slots → writes enums.yaml |
doc_gen_scripts/build_classes_from_checklist.py |
Reads checklist Excel + slots → writes classes.yaml |
doc_gen_scripts/merge_slots.py |
Merges slots + enums + classes → schema.yaml |
doc_gen_scripts/generate_checklist_excel.py |
Reads schema.yaml → Excel checklist (for download) |
doc_gen_scripts/generate_FULLtemplate_excel.py |
Reads schema.yaml → FULL Excel template (for researchers) |
Run the first three to build the schema; then run the last two to produce the Excel files researchers use.
schema.yaml— regenerated from slots + enums + classes.
As described in #16, an issue was found with the excel generation scripts. v.1.02 has been restored as the correct excel files to download. v1.0.3 will be returned when the problem is fixed.
v1.0.3, released on 2025-07-31
For a detailed record of updates and corrections in all versions, please see the CHANGELOG.md.
We welcome your feedback and suggestions to improve the FAIRe checklist and templates.
Please report any errors, typos, or enhancement ideas by creating an Issue in this repository.
Thank you for helping us make the FAIRe checklist better!