Skip to content
Draft
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 .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ venv.bak/
# MkDocs build output
docs/site/
public/docs/mavedb/
public/docs/gks-vignettes/

# IDEs and editors
.vscode/
Expand Down
2 changes: 2 additions & 0 deletions docs-gks-vignettes/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.venv/
site/
14 changes: 14 additions & 0 deletions docs-gks-vignettes/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# MaveDB × GA4GH GKS Vignettes

These pages contain real-world walk-throughs of how **MaveDB** uses the GA4GH **Genomic Knowledge Standards** to solve fundamental problems in sharing multiplexed assay of variant effect (MAVE) and other functional assay data.

These are drafted for contribution to the [GA4GH GKS Starter Kit](https://github.com/ga4gh/gks-starter-kit); this site is an internal preview. Each vignette describes a real implementation, including the scope of the problem, the underlying data, the tools, and the GKS standards, written to be accessible to a teammate or to leadership.

## The vignettes

- [**Giving every MAVE variant a precise, computable identity with VRS**](vignettes/mavedb-mave-variants-vrs/vignette.md) — mapping every variant into VRS 2.0 as MaveDB's canonical variant representation. *(VRS · production)*
- [**Annotating a variant once across every score set that measured it**](vignettes/mavedb-vrs-cross-score-set-harmonization/vignette.md) — the VRS digest as a harmonization key. *(VRS · pilot)*
- [**Carrying a measured variant across molecular levels with Cat-VRS**](vignettes/mavedb-protein-variant-cat-vrs/vignette.md) — a variant as a category for its biologically equivalent representations. *(Cat-VRS · proposal)*
- [**Sharing MAVE functional evidence as computable statements with VA-Spec**](vignettes/mavedb-functional-evidence-va-spec/vignette.md) — study results, functional-impact statements, and pathogenicity statements. *(VA-Spec · production)*

These threads are intended to tell a connected story, following the same variants from VRS identity, through harmonization and categorization, and into VA-Spec evidence.
Loading