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

Documentation issue - MIxS update #5

Open
ssarrafan opened this issue Feb 1, 2022 · 16 comments
Open

Documentation issue - MIxS update #5

ssarrafan opened this issue Feb 1, 2022 · 16 comments
Assignees
Labels
backlog documentation Improvements or additions to documentation

Comments

@ssarrafan
Copy link

Update MIxS to use v6

@ssarrafan ssarrafan added this to the Sprint 11 milestone Feb 1, 2022
@mslarae13
Copy link
Contributor

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
Copy link

wdduncan commented Feb 3, 2022

@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 ssarrafan modified the milestones: Sprint 11, Sprint 13 Mar 29, 2022
@ssarrafan
Copy link
Author

Moving documentation issue to April per @kwdavenport

@mslarae13
Copy link
Contributor

@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
Copy link
Author

@turbomam I will re-assign to you.

@ssarrafan ssarrafan assigned turbomam and unassigned mslarae13 Apr 1, 2022
@turbomam
Copy link
Member

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

  • environment
    • alt
    • collection_date
    • depth
    • elev
    • env_broad_scale
    • env_local_scale
    • env_medium
    • geo_loc_name
    • lat_lon
    • temp
  • investigation
    • samp_name
    • samp_taxon_id
    • project_name
    • experimental_factor
    • neg_cont_type
    • pos_cont_type

@turbomam
Copy link
Member

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

@ssarrafan
Copy link
Author

@kwdavenport can we consider this issue closed?

@kwdavenport
Copy link
Contributor

kwdavenport commented Apr 28, 2022 via email

@ssarrafan
Copy link
Author

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

@ssarrafan ssarrafan modified the milestones: Sprint 14, Sprint 15 May 23, 2022
@turbomam
Copy link
Member

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
Copy link
Member

@turbomam
Copy link
Member

turbomam commented Jul 5, 2022

@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
Copy link
Author

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 ssarrafan modified the milestones: Sprint 15, Sprint 16 Jul 5, 2022
@ssarrafan
Copy link
Author

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 ssarrafan removed this from the Sprint 16 milestone Jul 29, 2022
@ssarrafan
Copy link
Author

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

@ssarrafan ssarrafan added the documentation Improvements or additions to documentation label Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants