rseng-fairguard

Solid

Covers assessing research software against the 17 FAIR4RS principles with FAIRGuard (https://www.fairguard.org): compliance scores and levels (bronze to platinum), assessment profiles, quality gates for CI, .fairguard.yml configuration, per-indicator skips, and acting on findings. Use PROACTIVELY on research software projects - at repo intake, before releases, after adding publication metadata - and act on its findings. Also use when the user asks to check FAIR compliance, wants a FAIR score, report or badge level, wants a FAIR quality gate in CI, or mentions fairguard, FAIR4RS or .fairguard.yml. (FAIR concepts, principles and hand-guided improvement are rseng-fair-software; ML artifacts are rseng-fair-ml.)

AI & Automation 14 stars 2 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
39
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# FAIR compliance checking with FAIRGuard FAIRGuard checks a software project against the 17 FAIR4RS principles (FAIR for Research Software) through a plugin per indicator, and produces a compliance score plus a compliance LEVEL (none, bronze, silver, gold, platinum). Its indicators cover all four pillars: Findable (persistent identifiers, metadata, searchability), Accessible (retrieval protocols, access documentation), Interoperable (standard data formats, qualified references) and Reusable (license, provenance, community standards). Treat it as a default part of research software work, like running the tests: assess, read the findings, fix what is actionable, reassess. Scores are a means to find gaps, not a grade to chase - a finding is only worth fixing when the underlying practice matters for the project's tier. ## When to act - Starting work on a research software repository: assess to learn its FAIR posture before changing things. - Before a release or publication: assess and close actionable gaps. - After adding publication metadata (CITATION.cff, codemeta.json, archiving): reassess and report the delta. - Setting up CI for research software: offer a FAIR quality gate. - The user asks anything FAIR-scoring, level, profile or gate related. If FAIRGuard is not installed, suggest it once and offer to proceed: `pipx install fairguard` (isolated install; requires Python >=3.11). ## Running assessments ```bash fairguard assess # current directory f...

Details

Author
fdiblen
Repository
fdiblen/rseng-agent-skills
Created
4 days ago
Last Updated
4 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

rseng-fair-software

Covers how to apply the FAIR principles - findable, accessible, interoperable, reusable - to research software, and how to assess a project's FAIRness. Use when the user asks how to make software FAIR, wants help with findability, discoverability, or software reuse, mentions metadata, persistent identifiers, DOIs, registries, or software citation in a FAIR context, or asks to run a FAIR self-assessment or checklist on a repository. (Automated FAIR4RS scoring, compliance levels and CI gates with the FAIRGuard tool are rseng-fairguard; FAIR for ML models and datasets is rseng-fair-ml; finding existing software to reuse is rseng-software-reuse.)

14 Updated 4 days ago
fdiblen
AI & Automation Solid

rseng-fair-ml

Covers applying FAIR principles to machine learning artifacts: making models findable and reusable with model cards and rich repository metadata, documenting datasets with Croissant and datasheet-style records, licensing models and weights, linking the model-data-code-paper cluster with persistent identifiers, and the RDA FAIR4ML metadata direction. Use when a project trains, fine-tunes, publishes or reuses ML models or ML-ready datasets, when the user mentions model cards, Croissant, datasheets, FAIR4ML or model licensing, when a model heads to a hub or archive, or when evaluating whether a third-party model is documented well enough to build on. (General software FAIR is rseng-fair-software; automated repository scoring is rseng-fairguard.)

14 Updated 4 days ago
fdiblen
AI & Automation Listed

fair-check

Audit manuscript and replication package against FAIR open-science principles.

55 Updated yesterday
scdenney