Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for setting up a basic mapping commons #299

Merged
merged 1 commit into from
Jul 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ nav:
- Presentations: presentations.md
- Basic Tutorial: tutorial.md
- How to use mapping predicates: mapping-predicates.md
- Set up a mapping registry/commons: mapping-commons.md
- Overview of Chaining Rules: chaining_rules.md
- A basic guide for the SSSOM toolkit: toolkit.md
- 5-Star Entity Mappings - Cheatsheet: 5star-mappings.md
Expand Down
21 changes: 21 additions & 0 deletions src/docs/mapping-commons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# How to set up a Mapping Commons

A mapping commons is an open, collaborative space for managing and reconciling mappings. The goal is to collect mappings from a variety of sources into a _mapping set registry_, standardise them into a common representation, curate some basic metrics such as "confidence" (how much does the community managing the commons trust a specific mapping source?) and provenance (where exactly did this mapping come from before it was integrated).

There is no agreed upon standard for mapping registries yet. SSSOM itself provides a [lighweight metadata model for mapping registries](https://mapping-commons.github.io/sssom/) which is, as of August 2023, under active development.

## Typical setup of a mapping commons

We recommend to base your mapping commons on a combination of GitHub (or GitLab) collaborative workflows (issues and discussions for the community, access management etc) and a git repository based on the [Mapping Commons Cookiecutter Template](https://github.com/mapping-commons/mapping-commons-cookiecutter) for version control of the mappings.

Using the template system above allows you to:

1. make use of basic CI and quality control for your mappings,
2. provides a standard way to document metadata about your mapping sets
3. provides a basic ETL system based on `gnu make` (which you dont have to use, its just convenient)
4. Provides a standardised registry format that can be re-used/imported by others.

Examples of Mapping Commons are:

1. https://github.com/mapping-commons/mh_mapping_initiative
1. https://gitlab.c-path.org/c-pathontology/mapping-commons