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 Manifest class #2230

Merged
merged 12 commits into from
Nov 7, 2024
Merged

Add Manifest class #2230

merged 12 commits into from
Nov 7, 2024

Conversation

kheal
Copy link
Contributor

@kheal kheal commented Oct 23, 2024

This PR

  1. Adds a Manifest class (inherits from Information class) to model collections of DataObjects records for workflows. Manifest class has slot manifest_category with range of ManifestCategoryEnum
  2. Adds in_manifest slot to DataObject to connect DataObjects to a Manifest or to multiple Manifestss
  3. Adds manifest_set to Database class
  4. Expands existing examples the use of the in_manifest slot, Manifest class, and manifest_set slot

No migration necessary, this only adds slots and classes and does not refactor existing classes or slots.

Addresses #766; should unblock microbiomedata/nmdc-server#1365

@kheal kheal self-assigned this Oct 23, 2024
Copy link

github-actions bot commented Oct 23, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://microbiomedata.github.io/nmdc-schema/pr-preview/pr-2230/
on branch gh-pages at 2024-11-06 22:06 UTC

@kheal
Copy link
Contributor Author

kheal commented Oct 23, 2024

@aclum, @SamuelPurvine, @corilo, @turbomam, @pdpiehowski - I could benefit from an early review and/or input on the ManifestCategoryEnum values and description for Manifest. I will plan to present at metadata meeting on 10/30.

@aclum
Copy link
Contributor

aclum commented Oct 31, 2024

the current values for ManifestCategoryEnum make sense to me. Tagging @mbthornton-lbl, if implemented nmdc_automation would have to check manifest_set to see if data objects should be combined together.

Copy link
Member

@turbomam turbomam left a comment

Choose a reason for hiding this comment

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

Thanks, this is good. Let's see what we can do together today in terms of refining the descriptions. I see you already have one comment about that. I'm going to suggest some more edits that emphasize minimal, realism-based descriptions.

I especially want to add comments about potential vulnerabilities in this modelling, which I think is mainly in the area of not enforcing some coupling with other schema elements, like any fractions manifest should correspond to data objects that were the output of one single fractionation process.

in_manifest:
range: Manifest
multivalued: true
#TODO KRH: add description and structured_pattern constraints
Copy link
Member

Choose a reason for hiding this comment

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

What's the timeline for adding a description? Can I help in any way?

Copy link
Member

Choose a reason for hiding this comment

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

one or more combinations of other DataObjects that can be analyzed together in the same context ?

src/schema/basic_classes.yaml Show resolved Hide resolved
src/schema/basic_classes.yaml Outdated Show resolved Hide resolved
src/schema/basic_classes.yaml Show resolved Hide resolved
src/schema/basic_classes.yaml Show resolved Hide resolved
src/schema/nmdc.yaml Outdated Show resolved Hide resolved
@kheal kheal marked this pull request as ready for review November 5, 2024 21:50
@kheal
Copy link
Contributor Author

kheal commented Nov 5, 2024

@turbomam - Thanks for the assist with the descriptions and suggested comments, I've incorporated them all now and I think this is ready for merging!

@kheal kheal merged commit f3a0312 into main Nov 7, 2024
3 checks passed
@kheal kheal deleted the manifest branch November 7, 2024 17:08
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.

4 participants