Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
177 commits
Select commit Hold shift + click to select a range
1074dbd
Add upload your data section on Home page
EstelleDa Nov 19, 2025
59bd5b9
Add an alerting message on multiple pages if users don't sign in. Dir…
EstelleDa Nov 25, 2025
9a81efb
Merge branch 'release-2025.5.2' into feature/estelle/573/uploadYourDa…
EstelleDa Nov 25, 2025
4ee6ac2
Modify the DefaultLayout.vue and related pages.
EstelleDa Nov 28, 2025
612d595
Merge remote-tracking branch 'origin/release-2025.5.3' into feature/e…
EstelleDa Dec 2, 2025
fafbc93
Remove some unnecessary parts and add a redirection function to Defau…
EstelleDa Dec 2, 2025
ca2728b
Merge pull request #576 from VariantEffect/feature/estelle/573/upload…
EstelleDa Dec 2, 2025
6153e48
Add molecular mechanism assessed controlled keywords to both Create E…
EstelleDa Dec 4, 2025
6aef60f
Merge pull request #590 from VariantEffect/feature/estelle/601/moleMe…
EstelleDa Dec 5, 2025
ee580c0
Upgrade PrimeVue to version 4
davereinhart Nov 3, 2025
96a62ca
Install tailwindcss, vite plugin, and update configuration.
davereinhart Nov 3, 2025
5ef8f0d
Rebase with release-2025.5.3
davereinhart Dec 5, 2025
8fb8a3e
Add Raw Read Identifier link to scoreset page.
EstelleDa Dec 9, 2025
c45cefd
wip: Bring documentation into the present
bencap Dec 10, 2025
2f2fe4a
fix: Update release version retrieval method in configuration
bencap Dec 10, 2025
6189494
Merge pull request #592 from VariantEffect/feature/estelle/125/addRaw…
EstelleDa Dec 10, 2025
a198810
Updating components and CSS post-upgrade to PrimeVue4 and tailwindCSS
davereinhart Dec 9, 2025
925028e
Updates to DashboardView to fix styling issues from upgrade to PrimeV…
davereinhart Dec 9, 2025
db586e3
Updating score set create, edit, view components and CSS post-upgrade…
davereinhart Dec 10, 2025
965f297
Fix CSS for tags and mave-collection-badges for consistent styling
davereinhart Dec 10, 2025
de26db6
Make the search result data table bigger and debug the SearchView pag…
EstelleDa Dec 12, 2025
1338ea4
Merge pull request #595 from VariantEffect/modify/estelle/556/adjustS…
EstelleDa Dec 12, 2025
74457a5
Fix position of MaveMD logo on home page
davereinhart Dec 12, 2025
8d194a9
Updates to HighlightsView to address formatting issues
davereinhart Dec 12, 2025
04ba648
Fix HomeScreen citation margins and align bottom of top 3 Card elements
davereinhart Dec 12, 2025
a427769
Re-add bullets to items in HomeScreen featured searches list
davereinhart Dec 12, 2025
a6fe32c
Fix positioning of search elements and replace deprecated Dropdown wi…
davereinhart Dec 12, 2025
a037afd
Add custom CSS and update ExperimentCreator component to replicate Pr…
davereinhart Dec 12, 2025
2fb577d
Fix primary publication input elements to always show label in floate…
davereinhart Dec 12, 2025
aedcb3a
Match size of keyword dropdown and description in put on ExperimentCr…
davereinhart Dec 12, 2025
c71c6c0
Fix styling issues and replace deprecated components in VariantScreen…
davereinhart Dec 12, 2025
18a064f
Fix formatting/alignment issues on ExperimentView page
davereinhart Dec 12, 2025
b9c5a66
Additional style changes to Experiment creator, editor, and viewer pages
davereinhart Dec 13, 2025
00e6bd9
Add delete buttons for keyword fields on ExperimentEditor page
davereinhart Dec 13, 2025
d6146bf
ScoreSetCreator cleanup and fixing formatting of superseded score set…
davereinhart Dec 13, 2025
a41a955
Keep publication identifiers label in floated position to avoid overl…
davereinhart Dec 15, 2025
691acab
Updates to ScoreSetCreator and CalibrationEditor to fix PrimeVue4 mig…
davereinhart Dec 15, 2025
8ea61b5
Replace TabView with Tabs component on ExperimentEditor screen
davereinhart Dec 15, 2025
3d12bdc
Replace InputSwitch with ToggleSwitch on ScoreSetView and update ORCi…
davereinhart Dec 15, 2025
b4e1017
Update ScoreSetEditor to resolve issues related to PrimeVue4 migration
davereinhart Dec 15, 2025
2359fdd
Replace InputSwitch with ToggleSwitch in CalibrationEditor and Primev…
davereinhart Dec 15, 2025
5697ed1
Add missing ul element to ExperimentView screen
davereinhart Dec 15, 2025
47f8793
Replace deprecated PrimeVue components in ScoreSetPreviewTable and Sc…
davereinhart Dec 15, 2025
93c865a
Fix ScoreSetCalibrationsView styling issues related to Primevue4 migr…
davereinhart Dec 15, 2025
d128075
Update Chips component on CollectionDataSetEditor to display properly…
davereinhart Dec 15, 2025
5ea0a04
Updating styles on StatisticsView to match prior to PrimeVue 4 upgrade
davereinhart Dec 15, 2025
f8b7919
Fix spacing of elements in nav bar
davereinhart Dec 15, 2025
558284e
Additional PrimeVue migration style changes, UI fixes, and replacing …
davereinhart Dec 17, 2025
d180c51
wip: update score calibration documentation
bencap Dec 17, 2025
26d33f3
Use stored VEP consequence for protein effect histogram filtering
sallybg Dec 18, 2025
095e11c
Merge pull request #594 from VariantEffect/davereinhart/primevue-upgrade
bencap Dec 18, 2025
6bd0d11
feat: enhance variant name retrieval logic for consistency
bencap Nov 27, 2025
6550670
feat: add download options for selected variant annotations
bencap Nov 27, 2025
d1c47f9
fix: correct spelling of 'annotatedVariantOptions' in download option…
bencap Dec 5, 2025
d9b4c71
feat: surface server message in toast for failed variant downloads wh…
bencap Dec 5, 2025
cca073d
Merge pull request #588 from VariantEffect/feature/bencap/572/export-…
bencap Dec 18, 2025
4d7cd56
Fix the typo of Delivery Method Description label
EstelleDa Dec 18, 2025
056dac2
Remove the unnecessary console.log.
EstelleDa Dec 18, 2025
6487dd0
Merge pull request #602 from VariantEffect/debug/estelle/617/controll…
EstelleDa Dec 18, 2025
6b7cace
wip: data set search documentation
bencap Dec 20, 2025
7c31ea7
wip: enhance docs for external integrations and data output formats
bencap Dec 22, 2025
a96f636
wip: visualization documentation
bencap Dec 22, 2025
24a448a
Replace deprecated PrimeVue InputSwitch component with ToggleSwitch
davereinhart Dec 29, 2025
a37bd6b
Remove unused components
davereinhart Dec 29, 2025
2f192d0
Fix component names
davereinhart Dec 29, 2025
a440565
Replace Primevue Dropdown component with Select
davereinhart Dec 29, 2025
80266dc
Replace Primevue Sidebar component with Drawer
davereinhart Dec 29, 2025
7f28a8f
Replace ExperimentCreator contributors Chip component with AutoComplete
davereinhart Dec 29, 2025
ef8e51c
Replace ExperimentCreator DOI identifiers Chip component with AutoCom…
davereinhart Dec 29, 2025
1fa844f
Replace ExperimentCreator raw read identifiers Chip component with Au…
davereinhart Dec 30, 2025
29ff44c
Update ExperimentEditor to replace Chips components with AutoComplete
davereinhart Dec 30, 2025
47ff830
Restore previous escape behavior on ExperimentCreator and ExperimentE…
davereinhart Dec 30, 2025
a5a5233
Replace Chips components with AutoComplete on ScoreSetCreator and Sco…
davereinhart Dec 30, 2025
a540f65
Remove unused imports
davereinhart Dec 30, 2025
ff816d9
Replace Chips component with AutoComplete on CollectionDataSetEditor
davereinhart Dec 30, 2025
6c0fff6
chore: update types for api changes
bencap Nov 26, 2025
c986283
Remove chip slots from AutoComplete components to prevent issue with …
davereinhart Dec 30, 2025
8a8b7ad
Remove custom chip slots from CalibrationEditor component for proper …
davereinhart Dec 30, 2025
c396713
feat: Refactor calibration components to use functional classificatio…
bencap Nov 26, 2025
5081487
feat: Enhance heatmap calibration logic to calculate range boundaries…
bencap Nov 26, 2025
9374df4
feat: Add visualization functionality for class-based histograms
bencap Nov 26, 2025
93ffd77
feat: Update CSV upload instructions to clarify required columns for …
bencap Nov 27, 2025
f81c7dd
fix: Correct InputText component usage in CalibrationEditor
bencap Dec 30, 2025
2817338
fix: validation errors for calibrations were persisting between save …
bencap Dec 30, 2025
fef3a60
fix: correct lower cased value assignment for evidence strengths in C…
bencap Dec 30, 2025
f3e7d9a
feat: add floating label for class name in CalibrationEditor
bencap Dec 30, 2025
1e51263
Redefine button styles via props and update formatting of error messa…
davereinhart Dec 31, 2025
956c2b3
Redefine button styles via props and move tooltip button styling to g…
davereinhart Dec 31, 2025
5555e46
Remove Primevue 3 theme.css import and customize Primeuve 4 theme col…
davereinhart Dec 31, 2025
3a978c4
Fix z-index issue causing menubar submenu being displayed under some …
davereinhart Dec 31, 2025
72dbf41
Adding global styles for headings that are otherwise dropped by tailwind
davereinhart Dec 31, 2025
80677b5
Applying heading styles to home page
davereinhart Dec 31, 2025
811c204
Set global button padding to match style prior to PrimeVue 4
davereinhart Dec 31, 2025
b03d556
Update buttons on ScoreSetView to use outlined prop instead of severity
davereinhart Dec 31, 2025
86798c6
Replace inline styles on ProteinStructureView with tailwind classes
davereinhart Dec 31, 2025
9c110c1
Update unordered list elements to use tailwind styles
davereinhart Dec 31, 2025
8b8cc2f
Replace span.p-float-label elements with Primevue 4 FloatLabels in Sc…
davereinhart Dec 31, 2025
a2a9a13
Replace span.p-float-label elements with Primevue 4 FloatLabels in Sc…
davereinhart Dec 31, 2025
3eb4b26
Replace span.p-float-label elements with Primevue 4 FloatLabels in Ex…
davereinhart Jan 1, 2026
63c069e
Replace span.p-float-label elements with Primevue 4 FloatLabels in Ex…
davereinhart Jan 1, 2026
7d4ab35
Replace span.p-float-label elements with Primevue 4 FloatLabels in Ca…
davereinhart Jan 2, 2026
5f053ac
Replace span.p-float-label elements with Primevue 4 FloatLabels in re…
davereinhart Jan 2, 2026
8b71960
Remove unused styles
davereinhart Jan 2, 2026
02bf950
Updates to ScoreSetCreator to restore disabled Steps feature and impr…
davereinhart Jan 2, 2026
8485e3c
ScoreSetCreator: create copy of createdTargetGenes when creating edit…
davereinhart Jan 5, 2026
a8e49f7
fix: remove TypeScript type annotation from calibrationDraftClassesFi…
bencap Jan 5, 2026
a9c6a92
feat: enhance calibration editor by resetting state and validation er…
bencap Jan 5, 2026
71429de
fix: use `functionalClassifications` property for wizard validation
bencap Jan 5, 2026
c3ab30e
refactor: replace InputSwitch with ToggleSwitch for improved consiste…
bencap Jan 5, 2026
bbeeaf9
Fix validation error paths throughout ScoreSetCreator form, other cle…
davereinhart Jan 5, 2026
6122035
Fix indentation of ul components on ScoreSetView
davereinhart Jan 5, 2026
54015e8
Updates to ExperimentCreator and ExperimentEditor to separate functio…
davereinhart Jan 6, 2026
865f72f
Add variables to track file counts for UploadFile components on Score…
davereinhart Jan 6, 2026
c781aca
Additional style/layout updates to more closely match state prior to …
davereinhart Jan 6, 2026
9528d1a
Cleanup
davereinhart Jan 6, 2026
91b68fa
Merge pull request #607 from VariantEffect/davereinhart/primevue3-purge
davereinhart Jan 7, 2026
2f96c2e
feat: handle IGVF external links
bencap Dec 13, 2025
c34cfa4
chore: update OpenAPI schema
bencap Dec 16, 2025
037c9c6
fix: update IGVF link text for clarity
bencap Dec 16, 2025
1032872
feat: add external link to IGVF Portal in ExperimentView
bencap Dec 16, 2025
fa06087
feat: add linkifyTextHtml function for converting URLs to clickable l…
bencap Dec 16, 2025
7145fce
feat: enable linkification of collection descriptions in CollectionVi…
bencap Dec 16, 2025
5faa199
feat: add IGVF resource links to HomeScreen
bencap Dec 16, 2025
cff8985
fix: image not found in built distributions
bencap Jan 6, 2026
0bb7b6d
Fix alignment of img elements on HomeScreen and CollectionBadge after…
davereinhart Jan 7, 2026
4cd4156
feat: treat heatmap tooltip as an overlay panel
bencap Dec 15, 2025
aabd314
feat: treat histogram tooltip as an overlay panel
bencap Dec 15, 2025
513f159
feat: add bins getter to histogram interface
bencap Dec 15, 2025
4bf6e97
feat: emit selection changes from ScoreSetHistogram
bencap Dec 15, 2025
f5b90bf
feat: lock selection in ScoreSetHistogram to maintain focus on the va…
bencap Dec 15, 2025
a208b4c
feat: add selection change handling to synchronize variant and histog…
bencap Dec 15, 2025
16d118d
feat: hide hover tooltip when selection tooltip is shown
bencap Dec 15, 2025
393981b
fix: prevent clearing internal bin selection when switching from datu…
bencap Dec 15, 2025
4c3fe4d
fix: update tooltip behavior to maintain selection tooltip visibility…
bencap Dec 15, 2025
7c684e5
feat: keep histogram selected bin highlighted and increase outline wi…
davereinhart Jan 7, 2026
1e7bd43
Clamp top position of histogram selection tooltip to keep within cont…
davereinhart Jan 7, 2026
8afe5e7
Determine target ref for syncing selected bins of histograms on Score…
davereinhart Jan 8, 2026
859fe6f
Lock selection on ScoreSetHistogram when variant is selected from Sco…
davereinhart Jan 8, 2026
0aa622a
Exclude variants with non-numeric score values from ScoreSetView vari…
davereinhart Jan 8, 2026
b3eef7a
chore: remove home link from toolbar
bencap Dec 23, 2025
e26076f
Replace Toolbar inline styling with tailwind classes
davereinhart Jan 8, 2026
eeaa0a2
doc: Add comment for TODO#608
bencap Jan 8, 2026
e16de4c
Merge pull request #603 from VariantEffect/chore/bencap/548/remove-ho…
bencap Jan 8, 2026
79ecbc3
Merge pull request #598 from VariantEffect/feature/bencap/539/variant…
bencap Jan 8, 2026
2651016
feat: integrate linkify-html for converting URLs to clickable links i…
bencap Jan 8, 2026
91e020d
feat: make variant cards clickable to navigate to the variant view
bencap Dec 24, 2025
6379483
fix: replace misplaced <p> tag causing formatting faliures
bencap Dec 24, 2025
2e61ae6
feat: Make ClinGen link a button
bencap Dec 26, 2025
a1f3154
feat: enhance variant search result layout and color scheme
bencap Dec 26, 2025
597c14f
style: make assay fact sheet scalable by using relative units
bencap Dec 26, 2025
650d498
Merge pull request #596 from VariantEffect/feature/bencap/dedicated-i…
bencap Jan 14, 2026
7ee5d52
style: use `text` instead of `p-button-text` for variant measurement …
bencap Jan 14, 2026
8595d40
Merge pull request #605 from VariantEffect/feature/bencap/535/directl…
bencap Jan 14, 2026
d494821
Merge branch 'release-2025.6.0' into feature/bencap/categorical-calib…
bencap Jan 14, 2026
8cab1c5
chore: primevue4 updates for CalibrationEditor
bencap Jan 14, 2026
b92d104
fix: remove const assignment and assign errors directly to dict
bencap Jan 14, 2026
f04c98c
Merge pull request #587 from VariantEffect/feature/bencap/categorical…
bencap Jan 14, 2026
6fa949d
On ScoreSetVisualizer heatmap group row selection, set value for corr…
davereinhart Jan 15, 2026
936ac8e
On heatmap column range selection, convert start and end coordinates …
davereinhart Jan 15, 2026
4c15855
Adjust ScoreSetVisualizer heatmap selected column range to account fo…
davereinhart Jan 16, 2026
530c224
Set non-selected color to white on ProteinStructureView for residues …
davereinhart Jan 16, 2026
b3a8817
Set pivot color to light gray on ScoreSetHeatmap to differentiate fro…
davereinhart Jan 16, 2026
0505d24
Add z index to protein structure viewer wrapper div so that it is on …
davereinhart Jan 16, 2026
0e4e435
Calculate heatmap selected range position from scales when no nodes e…
davereinhart Jan 16, 2026
d8146f5
Only show ScoreSetHeatmap button to open protein visualization if usi…
davereinhart Jan 16, 2026
b4b9d19
Change heatmap background color to white to be visually distinct from…
davereinhart Jan 21, 2026
d8c9f97
Set default color for residues in protein structure to white when no …
davereinhart Jan 21, 2026
a6c59c1
Keep track of min and max X value for heatmap content and do not draw…
davereinhart Jan 21, 2026
0bcf7a0
Only show protein visualization button on heatmap controls if using p…
davereinhart Jan 22, 2026
5bcbfe5
Merge pull request #612 from VariantEffect/davereinhart/protein-viz-f…
davereinhart Jan 27, 2026
292f77b
docs: Hide incomplete pages from docs index
bencap Jan 27, 2026
c232ec0
Merge pull request #613 from VariantEffect/docs/bencap/scoped-docs-fo…
bencap Jan 27, 2026
d8aba72
feat: use mapped HGNC name for assay facts gene text when available
bencap Dec 13, 2025
7aeaeff
Merge pull request #600 from VariantEffect/use-vep-consequence
bencap Feb 3, 2026
2e4aad4
Merge pull request #597 from VariantEffect/feature/bencap/450/use-map…
bencap Feb 5, 2026
d841d65
fix (#616): ensure VA download options are only displayed when available
bencap Feb 5, 2026
cd6fd09
chore: bump version to 2026.1.0
bencap Feb 5, 2026
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
918 changes: 791 additions & 127 deletions package-lock.json

Large diffs are not rendered by default.

11 changes: 8 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mavedb-ui",
"version": "2025.5.2",
"version": "2026.1.0",
"private": true,
"type": "module",
"scripts": {
Expand All @@ -15,6 +15,8 @@
"@fortawesome/free-regular-svg-icons": "^7.0.0",
"@fortawesome/free-solid-svg-icons": "^7.0.0",
"@fortawesome/vue-fontawesome": "^3.1.1",
"@primevue/themes": "^4.4.1",
"@tailwindcss/vite": "^4.1.16",
"@unhead/vue": "^2.0.17",
"axios": "^1.11.0",
"chart.js": "^4.4.1",
Expand All @@ -41,6 +43,8 @@
"jsonpath-plus": "^10.3.0",
"jsonwebtoken": "^9.0.2",
"jszip": "^3.10.1",
"linkify-html": "^4.3.2",
"linkifyjs": "^4.3.2",
"lodash": "^4.17.21",
"marked": "^11.1.0",
"moment": "^2.29.4",
Expand All @@ -52,12 +56,13 @@
"pluralize": "^8.0.0",
"primeflex": "^3.3.1",
"primeicons": "^6.0.1",
"primevue": "3.52.0",
"primevue": "^4.4.1",
"rest-client-vue": "^1.2.0-b2",
"tailwindcss": "^4.1.16",
"universal-base64url": "~1.1.0",
"uuid": "^9.0.1",
"vee-validate": "^4.12.2",
"vue": "^3.3.11",
"vue": "^3.4.0",
"vue-debounce": "^4.0.1",
"vue-router": "^4.2.5",
"vuex": "^4.1.0",
Expand Down
2 changes: 1 addition & 1 deletion public/docs/mavedb/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: fe61ab4a9503c0d35fa0eb1b91172649
config: ad4296d0777365c695d333cc4f10b8f1
tags: 645f666f9bcd5a90fca523b33c5a78b7
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/mavedb/_images/msh2_heatmap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 28 additions & 3 deletions public/docs/mavedb/_sources/accession_numbers.rst.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
MaveDB accession numbers
============================

.. _accession-numbers-intro:

MaveDB accession numbers use the `URN (Uniform Resource Name) format <https://tools.ietf.org/html/rfc8141>`_.
The accession numbers have a hierarchical structure that reflects the relationship between
experiment sets, experiments, score sets, and individual variants in MaveDB.
experiment sets, experiments, score sets, and individual variants in MaveDB. URNs are also used to uniquely identify
other resources in MaveDB, such as calibrations and collections.

All public accession numbers start with the string `urn:mavedb:` followed by the experiment set number
(eight digits, zero-padded).
URNs within the experiment set/experiment/score set/variant hierarchy start with the string `urn:mavedb:`
followed by the experiment set number (eight digits, zero-padded).
Experiments are indexed by letter within the experiment set.
If necessary, ``aa``, ``ab``, etc. will follow ``z``.
Score sets are indexed by number within the experiment.
Expand All @@ -28,20 +31,42 @@ Score sets are indexed by number within the experiment.
* - ``tmp:446191af-c1f8-4891-9f67-de152e9d328b``
- temporary accession number

.. _end-accession-numbers-intro:

Meta-analysis accession numbers
####################################

.. _meta-analysis-accession-numbers:

Meta-analysis score sets use the special ``0`` experiment instead of a letter.

Meta-analysis score sets that include data from a single experiment set will use that experiment set's number.
For meta-analyses that use data from multiple experiment sets,
a new experiment set number will be assigned for all meta-analyses that include data from the same experiment sets.
These meta-analysis-only experiment sets will only contain the ``0`` experiment.

.. _end-meta-analysis-accession-numbers:

Temporary accession numbers
###################################

.. _temporary-accession-numbers:

When first uploaded, records are given a temporary accession number starting with ``tmp:``.
These temporary accessions are not structured according to the record type.

MaveDB URNs are created when the temporary records are made publicly viewable by publishing a score set.

.. _end-temporary-accession-numbers:

URNs for other resources
###################################

.. _other-resources-urns:

Other resources in MaveDB that exists outside of the data set hierarchy, such as calibrations and collections, also use URNs starting with ``urn:mavedb:``.
This is followed by a resource type identifier (e.g., ``calibration``, ``collection``) and a unique
resource identifier. For example, the URN for a calibration resource might be
``urn:mavedb:calibration-11111111-2222-3333-aaaa-bbbbccccdddd``.

.. _end-other-resources-urns:
26 changes: 19 additions & 7 deletions public/docs/mavedb/_sources/accounts.rst.txt
Original file line number Diff line number Diff line change
@@ -1,28 +1,40 @@
User account management
==================================

.. _user-accounts-intro:

User account authentication in MaveDB is handled through `ORCID iD <https://orcid.org/>`_.
If you do not have an `ORCID iD <https://orcid.org/>`_, you can register a new one for free using their service.

Your MaveDB account will be created once you log in for the first time.

You must have logged in at least once to MaveDB using your ORCID iD in order to be added as a :ref:`contributor<data-set-contributors>` to a dataset.

.. _end-user-accounts-intro:

Setting an email address
###################################

.. _setting-email-address:

MaveDB can only view public email addresses associated with your `ORCID iD <https://orcid.org/>`_.
If you do not have one of these set and would like to receive emails from MaveDB,
you can provide an email address using the `Profile settings page <https://www.mavedb.org/#/settings/>`_
(requires login).
(requires login). To upload datasets, you must provide an email address.

MaveDB will send automatic emails when upload tasks complete or when your dataset permissions are changed.
MaveDB maintainers will also use this email address to notify you of important updates that affect the usability of
your datasets.
.. _end-setting-email-address:

API access tokens
###################################

Users can generate an API access token to access :ref:`private datasets<Temporary accession numbers>` via API
using the `Profile settings page <https://www.mavedb.org/#/settings/>`_ (requires login).
.. _api-access-tokens:

Users may generate an API access token to authenticate with the `MaveDB API <https://api.mavedb.org/docs>`_. This token
will allow you to perform actions such as uploading and modifying datasets programmatically, fetching :ref:`private data sets<temporary-accession-numbers>`,
or managing your account. You can generate and revoke API access tokens using the
`Profile settings page <https://www.mavedb.org/#/settings/>`_ (requires login).

Only one API access token can be active for a given account.
Generating a new token will invalidate the old one.
Generating a new token will invalidate the old one.

.. _end-api-access-tokens:
10 changes: 10 additions & 0 deletions public/docs/mavedb/_sources/api/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
MaveDB API
==================================

.. _mavedb-api-intro:

The MaveDB API provides programmatic access to MaveDB data and functionality.

You can explore the API documentation at the following link: `MaveDB API Documentation <https://api.mavedb.org/docs>`_.

.. _end-mavedb-api-intro:
60 changes: 60 additions & 0 deletions public/docs/mavedb/_sources/assay_facts.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
Assay facts
===================================

.. _assay-facts-intro:

MaveDB captures key facts about the experimental assay used to generate variant effect measurements
from controlled keywords based on a :ref:`controlled vocabulary<mave controlled vocabulary>`. This information is then used
to generate a concise summary of assay facts that is displayed on the score set page.

.. figure:: images/brca1_assay_facts_example.png
:name: assay-facts-example
:alt: Assay facts section from a MaveDB score set page
:align: left

Example of the assay facts section from a score set

This figure shows the assay facts section from
`urn:mavedb:00000097-0-2 <https://mavedb.org/score-sets/urn:mavedb:00000097-0-2>`_,
which describes saturation genome editing of *BRCA1*.

.. _end-assay-facts-intro:

Assay fact sheet properties
------------------------------------

.. _assay-fact-sheet-properties:

**Gene Symbol**
The HGNC gene symbol for the target gene being assayed.

**Assay type**
The type of functional assay used to measure variant effects. This corresponds to the :ref:`phenotypic assay method<phenotypic assay method>` controlled vocabulary term.

**Molecular mechanism**
The molecular mechanism by which the assay measures variant effects. This corresponds to the :ref:`molecular mechanism<molecular mechanism assessed>` controlled vocabulary term.

**Variant consequences detected**
The types of variant consequences that the assay is capable of detecting. This corresponds to the :ref:`phenotypic assay mechanism<phenotypic assay mechanism>` controlled vocabulary term.

**Model system**
The biological system in which the assay was performed. This corresponds to the :ref:`model system<phenotypic assay model system>` controlled vocabulary term.

**Detects splicing variants**
Whether the assay is capable of detecting splicing variants. Based on assay design, and inferred based on a combination of the :ref:`variant library creation method<variant library creation methods>` and
other terms.

**Detects nonsense-mediated decay (NMD) variants**
Whether the assay is capable of detecting NMD variants. Based on assay design, and inferred based on a combination of the :ref:`variant library creation method<variant library creation methods>` and
other terms.

**OddsPaths**
The Odds of Pathogenicity score calculated for abnormal and normal functional readouts, if applicable. These OddsPaths are based on the framework described in `Brnich et al., 2019 <https://doi.org/10.1186/s13073-019-0690-2>`_.

.. note::
OddsPath calculations are provided when available.

For some assays, MaveDB maintainers may have selected OddsPaths other than those submitted by the data contributor,
based on updated calibrations or reanalyses of the data. In these cases, the source of the OddsPath scores will be indicated on the score set page.

.. _end-assay-fact-sheet-properties:
32 changes: 32 additions & 0 deletions public/docs/mavedb/_sources/bulk_downloads.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Bulk downloads
==================================

.. _bulk-downloads:

A complete set of MaveDB data and metadata is available as a bulk download
hosted on `Zenodo <https://zenodo.org/>`_.

.. note::
The associated DOI for the most recent version of the archive is
`10.5281/zenodo.11201736 <https://doi.org/10.5281/zenodo.11201736>`_.

The archive will be updated twice yearly in May and November.

The archive contains a single JSON document called ``main.json`` that provides
the structured metadata for every :ref:`experiment set<experiment sets>`,
:ref:`experiment<experiments>`, and :ref:`score set<score sets>`.
Score set data is provided in ``.csv`` format,
with separate score and count files for each record as appropriate.
Each file is named using the :ref:`score set urn<mavedb accession numbers>`.

Users who are interested in downloading a large number of MaveDB datasets are
strongly encouraged to use and cite these archival releases,
particularly for machine learning or AI-based studies where the associated data
needs to be clearly identified for reproducibility.

Datasets released using the `CC0 <https://creativecommons.org/public-domain/cc0/>`_
public domain license are included in the archive, and this is the license
applied to the archive itself.
Datasets provided by MaveDB under other licenses are not currently included.

.. _end-bulk-downloads:
18 changes: 17 additions & 1 deletion public/docs/mavedb/_sources/citation.rst.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
Citing MaveDB
==================================

When citing MaveDB, please refer to:
.. _citing-mavedb:

When citing MaveDB, please refer to the most recent publication:

Rubin AF, Stone J, Bianchi AH, Capodanno BJ, Da EY, Dias M, Esposito D,
Frazer J, Fu Y, Grindstaff SB, Harrington MR, Li I, McEwen AE, Min JK, Moore N,
Moscatelli OG, Ong J, Polunina PV, Rollins JE, Rollins NJ, Snyder AE,
Tam A, Wakefield MJ, Ye SS, Starita LM, Bryant VL, Marks DS, Fowler DM.
MaveDB 2024: a curated community database with over seven million variant effects from multiplexed functional assays.
*Genome Biol.* 2025 Jan 21;26(1):13.
doi: `10.1186/s13059-025-03476-y <https://doi.org/10.1186/s13059-025-03476-y>`_.
PMID: `39838450 <https://pubmed.ncbi.nlm.nih.gov/39838450/>`_;
PMCID: `PMC11753097 <http://www.ncbi.nlm.nih.gov/pmc/articles/pmc11753097/>`_.

The previous citation is:

Esposito D, Weile J, Shendure J, Starita LM, Papenfuss AT, Roth FP, Fowler DM, Rubin AF.
MaveDB: an open-source platform to distribute and interpret data from multiplexed assays of variant effect.
Expand All @@ -13,3 +27,5 @@ PMCID: `PMC6827219 <http://www.ncbi.nlm.nih.gov/pmc/articles/pmc6827219/>`_.
When citing data downloaded from MaveDB, please refer to the MaveDB publication (above) as well as the original
publications where the datasets were reported.
These citations are usually available on the associated experiment and score set pages.

.. _end-citing-mavedb:
Empty file.
Loading