microbiomedata / NMDC_documentation

Document workflows, schemas, and portal
https://nmdc-documentation.readthedocs.io
2 stars 3 forks source link

Documentation issue - MIxS update #5

Open ssarrafan opened 2 years ago

ssarrafan commented 2 years ago

Update MIxS to use v6

mslarae13 commented 2 years ago

Currently, from what I can tell, an instance of MIxS v5 was pulled and added to the schema. This should be removed. MIxS v6 read the docs should be pulled from MIxS instead of copying an instance.

@cmungall , @wdduncan ... can you chime in if you agree with this / provide some context on what we need to do to accomplish this? Will this affect the portal .. or break anything else?

wdduncan commented 2 years ago

@mslarae13 Has MIXS 6 been released yet? I didn't think it had.

Once it is released, our plan is to update the schema with the new version.

ssarrafan commented 2 years ago

Moving documentation issue to April per @kwdavenport

mslarae13 commented 2 years ago

@turbomam I think this should be assigned to you? I have NO idea where the MIxS v6 documentation is, or how we will pull it in.

If you disagree, we should disucss soon to ensure the documentation gets completed for the April release.

ssarrafan commented 2 years ago

@turbomam I will re-assign to you.

turbomam commented 2 years ago

I'm going to start collecting some notes here. I don't mean to say that this is all the documentation I'll be providing!.

The mechanism for integrating MIxS terms, specifically those from 12 different packages, is briefly described in nmdc-schema PR #292

Especially see the quick and dirty code that does the integration, util/reconsititute_mixs.py and the resulting LinkML file, src/schema/mixs_6_for_nmdc.yaml

The process is started by examining all slots included by the previous, essentially static MIxS5 import, ../src/schema/mixs.yaml, all slots assigned to the NMDC biosample class, and all classes assigned to the evolving NMDC DH schema, for example here.

I can include/check all slots for a MIMS sample, like the environmental section, etc. (but not the grouping slots themselves!)

section core terms
environment 10
investigation 6
nucleic acid sequence source 25
sequencing 57

like

turbomam commented 2 years ago

Rough stream of consciousness draft: Integration of MIxS into the NMDC schema: tech notes

ssarrafan commented 2 years ago

@kwdavenport can we consider this issue closed?

kwdavenport commented 2 years ago

I don't think so. I'll be talking with Mark and Montana tomorrow. I am thinking it should go into the May sprint, but I can let you know after our meeting (at 8am PT).


From: ssarrafan @.***> Sent: Thursday, April 28, 2022 3:54 PM To: microbiomedata/NMDC_documentation Cc: Davenport, Karen Walston; Mention Subject: [EXTERNAL] Re: [microbiomedata/NMDC_documentation] Documentation issue - MIxS update (Issue #5)

@kwdavenporthttps://urldefense.com/v3/__https://github.com/kwdavenport__;!!Bt8fGhp8LhKGRg!TsI9X1gsBEovJqXiPDvYgiuQgZuS3aQp9cUyeIzLbtni78F9UOhLlqF7ypC2qREu1MM$ can we consider this issue closed?

— Reply to this email directly, view it on GitHubhttps://urldefense.com/v3/__https://github.com/microbiomedata/NMDC_documentation/issues/5*issuecomment-1112689037__;Iw!!Bt8fGhp8LhKGRg!TsI9X1gsBEovJqXiPDvYgiuQgZuS3aQp9cUyeIzLbtni78F9UOhLlqF7ypC2n3fEYTc$, or unsubscribehttps://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/ACOC2VD5Q6C7MEGRTC5M2SDVHMCKZANCNFSM5NH76OLA__;!!Bt8fGhp8LhKGRg!TsI9X1gsBEovJqXiPDvYgiuQgZuS3aQp9cUyeIzLbtni78F9UOhLlqF7ypC2NpOHPkk$. You are receiving this because you were mentioned.Message ID: @.***>

ssarrafan commented 2 years ago

I haven't heard back so I will move this to the May sprint @kwdavenport @turbomam

turbomam commented 2 years ago

How can we get the best, most automated integration between @sujaypatil96's https://microbiomedata.github.io/mixs and https://nmdc-docs-sphinx.readthedocs.io/en/latest/reference/metadata/combined_schema_docs.html#mixs-soil-package (for example), which is managed by @kwdavenport and Yan?

turbomam commented 2 years ago

https://github.com/cidgoh/DataHarmonizer/issues/313

turbomam commented 2 years ago

@ssarrafan : There are Makefile steps for ongoing integration of MIxS terms into the NMDC schema, but it should be automated

I haven't really done anything to contribute to the NMDC documentation pages yet. The MIxS content seems like a mixture of narrative content with some cut-and-past that may not be completely accurate any more.

ssarrafan commented 2 years ago

I'll move this to July then but let me know if you are not planning to work on it and I can move it to the backlog. I'm not sure how high the priority for this is? @cmungall @emileyfadrosh

ssarrafan commented 2 years ago

This issue has been in multiple sprints. I'm going to move it to the backlog. Let me know if it should be moved to the active sprint. @turbomam @mslarae13

ssarrafan commented 7 months ago

@shreddd if we discuss documentation at SW Best Practices this is a good issue to refer to