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 slot and enumeration to MetaproteomicsAnalysis class and implement migrator. #2276

Merged
merged 6 commits into from
Dec 4, 2024

Conversation

kheal
Copy link
Contributor

@kheal kheal commented Nov 26, 2024

This MR will close #2256.

It will

  1. Add the required slot metaproteomics_analysis_category to the MetaproteomicsAnalysis class
  2. Add the definition of the slot metaproteomics_analysis_category to the schema, with a range of MetaproteomicsAnalysisCategoryEnum
  3. Add definition of the MetaproteomicsAnalysisCategoryEnum to the schema
  4. Adjust valid test to include the metaproteomics_analysis_category
  5. Add invalid test for record that is missing the metaproteomics_analysis_category
  6. Add migrator that populates the records of all existing MetaproteomicsAnalysis records with metaproteomics_analysis_category value of matched_metagenome. Note that this logic is used because all current data use a matched_metagenome and we're adding this enumeration in preparation for the second category of analysis.

I have tested the migrator locally with no issues.

@kheal kheal self-assigned this Nov 26, 2024
Copy link

github-actions bot commented Nov 26, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://microbiomedata.github.io/nmdc-schema/pr-preview/pr-2276/
on branch gh-pages at 2024-12-03 23:47 UTC

@kheal kheal marked this pull request as ready for review November 26, 2024 23:40
Copy link
Collaborator

@eecavanna eecavanna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve of the migrator as is (looks good to me). And thank you for writing that PR description, which I found easy to read/follow.

@eecavanna
Copy link
Collaborator

FYI: The deadline for merging this into main for inclusion in the December NMDC Release is this Wednesday, December 4.

@kheal
Copy link
Contributor Author

kheal commented Dec 4, 2024

I've incorporated edits from @SamuelPurvine regarding PV descriptions.

@turbomam - please review this before Wednesday, December 4, it's important for the new Metaproteomics workflow to have this enumeration in place and we want to use that workflow to process new data for the renewal.

enums:
MetaproteomicsAnalysisCategoryEnum:
description: The category of metaproteomics analysis being performed.
permissible_values:
Copy link
Member

@turbomam turbomam Dec 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the PV descriptions are more value-added than the MetaproteomicsAnalysisCategoryEnum description!

@@ -0,0 +1,13 @@
# This example is invalid because it is missing the required slot `metaproteomics_analysis_category` and that slot is required by the schema.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you

@kheal kheal merged commit 4722bc8 into main Dec 4, 2024
3 checks passed
@kheal kheal deleted the 2256_metap_categories branch December 18, 2024 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add slot and enumeration to MetaproteomicsAnalysis to enable separate types of workflows
3 participants