Skip to content

Commit 0f1a4b5

Browse files
committed
Expand FAIR Mappings Schema documentation and model
Enhanced the about and index documentation to provide background, usage examples, and detailed schema overview. The schema YAML was significantly extended: new enums for source and mapping types, expanded slots for provenance, licensing, and source metadata, and new classes for Agent, Person, Organization, Software, and Source. The MappingSpecification class now supports richer metadata and explicit subject/object source modeling, aligning with FAIR principles and community best practices.
1 parent 5dd5e81 commit 0f1a4b5

3 files changed

Lines changed: 499 additions & 136 deletions

File tree

docs/about.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
1-
# About fair-mappings-schema
1+
# About FAIR Mappings Schema
22

3-
A basic metadata schema for FAIR mapping specifications
3+
## Background
4+
5+
Semantic mappings between ontologies, vocabularies, databases, and other data sources are essential for data integration and interoperability. However, these mappings are often poorly documented, difficult to discover, and lack the metadata needed to assess their quality and provenance.
6+
7+
The FAIR Mappings Schema addresses this gap by providing a minimal but comprehensive metadata model for describing mapping specifications in a way that adheres to [FAIR principles](https://www.go-fair.org/fair-principles/) (Findable, Accessible, Interoperable, Reusable).
8+
9+
## RDA FAIR Mappings Working Group
10+
11+
This schema is developed by the [RDA FAIR Mappings Working Group](https://mapping-commons.github.io/rda-fair-mappings/), which brings together researchers, practitioners, and standards developers to establish best practices for creating and sharing FAIR mappings.
12+
13+
The working group aims to:
14+
15+
- Define metadata standards for mapping specifications
16+
- Promote interoperability between different mapping formats
17+
- Build a community around mapping best practices
18+
19+
## Schema Design
20+
21+
The schema is built using [LinkML](https://linkml.io/), a flexible modeling language that generates multiple representations including JSON Schema, Python dataclasses, and RDF/OWL.
22+
23+
### Core Concepts
24+
25+
- **MappingSpecification**: The central class representing a mapping between sources
26+
- **Source**: A data source (ontology, database, vocabulary, schema, or API) from which entities are drawn
27+
- **Agent**: An entity (person, organization, or software) that contributes to creating mappings
28+
29+
## Contributing
30+
31+
Contributions are welcome. Please visit the [GitHub repository](https://github.com/mapping-commons/fair-mappings-schema) to report issues or submit pull requests.
32+
33+
## License
34+
35+
This project is licensed under Apache-2.0.

docs/index.md

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,52 @@
1-
# fair-mappings-schema
1+
# FAIR Mappings Schema
22

3-
A basic metadata schema for FAIR mapping specifications
3+
A minimal metadata schema for describing FAIR mapping specifications between data sources.
44

5-
- Auto-generated [schema documentation](elements/index.md)
5+
## Overview
6+
7+
The FAIR Mappings Schema provides a standardized way to describe mappings between different data sources such as ontologies, databases, vocabularies, and schemas. It captures essential metadata about mapping specifications including provenance, licensing, and the sources being mapped.
8+
9+
This schema is developed as part of the [RDA FAIR Mappings Working Group](https://mapping-commons.github.io/rda-fair-mappings/) effort to improve the findability, accessibility, interoperability, and reusability of semantic mappings.
10+
11+
## Key Features
12+
13+
- **Source Description**: Describe subject and object sources with their types, versions, and access URLs
14+
- **Provenance Tracking**: Record authors, creators, reviewers, and publication dates
15+
- **Mapping Specification system agnostic**: Can be used, or easily mapped to, SSSOM, R2RML, RML, SPARQL, YARRRML, XSLT, SHACL, and other mapping formats.
16+
17+
## Example
18+
19+
```yaml
20+
---
21+
publication_date: "2024-01-15"
22+
license: CC-BY-4.0
23+
version: "1.0.0"
24+
description: Mappings between disease ontologies DO and MONDO
25+
type: sssom
26+
mapping_method: manual curation
27+
documentation: https://example.org/do-mondo-mappings/docs
28+
content_url: https://example.org/mappings/do-mondo.sssom.tsv
29+
subject_source:
30+
name: Disease Ontology
31+
version: "2024-01-01"
32+
type: ontology
33+
documentation: https://disease-ontology.org/
34+
content_url: http://purl.obolibrary.org/obo/doid.owl
35+
content_type: application/rdf+xml
36+
object_source:
37+
name: Mondo Disease Ontology
38+
version: "2024-01-10"
39+
type: ontology
40+
documentation: https://mondo.monarchinitiative.org/
41+
content_url: http://purl.obolibrary.org/obo/mondo.owl
42+
content_type: application/rdf+xml
43+
```
44+
45+
## Documentation
46+
47+
- [Schema Elements](elements/index.md) - Documentation for all schema classes, slots, and enums.
48+
49+
## Quick Links
50+
51+
- [RDA FAIR Mappings Working Group](https://mapping-commons.github.io/rda-fair-mappings/)
52+
- [GitHub Repository](https://github.com/mapping-commons/fair-mappings-schema)

0 commit comments

Comments
 (0)