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

deprecate tot_nitro slot #751

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mslarae13
Copy link
Contributor

@mslarae13 mslarae13 commented Jan 13, 2024

Fixes #680

tot_nitro =
Total nitrogen concentration of water samples, calculated by: total nitrogen = total dissolved nitrogen + particulate nitrogen. Can also be measured without filtering, reported as nitrogen
domain_of:

  • HydrocarbonResourcesCores
  • HydrocarbonResourcesFluidsSwabs
  • WastewaterSludge
  • Water

tot_nitro_content =
Total nitrogen content of the sample
domain_of:

  • Agriculture
  • FoodFarmEnvironment
  • MicrobialMatBiofilm
  • Sediment
  • Soil

tot_nitro & tot_nitro_content are the same, with the exception that tot_nitro is water specific in its description

In this PR,

  • marked tot_nitro for deprecation
  • changed anywhere tot_nitro it used to now use tot_nitro_content
    • HydrocarbonResourcesFluidsSwabs
    • Water
    • WastewaterSludge
    • HydrocarbonResourcesCores

@cmungall
Copy link
Contributor

cmungall commented Apr 5, 2024

What is the MIxS policy on deprecation?

I would not delete this as you have done in the PR. Instead

  • mark as deprecated
  • and a replacement annotation to tot_nitro_content

Copy link
Contributor

@cmungall cmungall left a comment

Choose a reason for hiding this comment

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

deprecate instead of delete

@mslarae13 mslarae13 changed the title remove tot_nitro slot deprecate tot_nitro slot Jul 17, 2024
@mslarae13
Copy link
Contributor Author

Discuss with CIG
IF there is need for HCR extensions to specify the tot_c content of the WATER vs the sample, we should update the description to emphasize that the water is NOT the same. And the tot_nitro_content should be used for the water extensions as in this case it is the sample.

In short
Is this slot describing a property of the SAMPLE or a some aspect of the ENVIRONMENT in which the sample was collected
See : #664 (comment)

@lschriml
Copy link
Member

lschriml commented Jul 18, 2024 via email

@mslarae13
Copy link
Contributor Author

Thanks @lschriml

I realized that from a comment from @cmungall
With that, I agree we could probably close this PR and issue, but we should visit the included discussion to make sure we're providing clear text on when these data as metadata values are about the "sample or a some aspect of the environemnt in which the sample was collected"

@lschriml
Copy link
Member

lschriml commented Jul 19, 2024 via email

@turbomam
Copy link
Member

turbomam commented Jul 22, 2024

This is a great discussion about user requirements and GSC/MIxS policies, esp. with respect to the LinkML deprecation procedure that has been approved by the TWG.

For me the key issue here is the effort that goes into creating MIxS terms and Checklists/Extensions in support of specific users from specific domains, versus the ongoing effort that goes into managing MIxS as a whole. @mslarae13 has opened a lot of thoughtful issues and PRs about what appear to be redundant terms. Whether they are merged with changes or just closed, the general theme shouldn't be neglected.

Folklore-like reflection on the history of a term can be a great addition to a GitHub ticket like this, but it shouldn't be necessary. At a minimum the descriptions of the two terms (or comments?) should be updated with clear differentiating language. Moving forward, all of this knowledge should be captured in a rolling format that is easy to integrate with the LinkML representation of MIxS.

@lschriml
Copy link
Member

lschriml commented Jul 22, 2024 via email

@lschriml lschriml added the 5-TechnicalUpdates Updates to LinkML or technical components of MIxS label Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5-TechnicalUpdates Updates to LinkML or technical components of MIxS
Projects
Status: Backlog
Development

Successfully merging this pull request may close these issues.

term total nitrogen concentration (tot_nitro) is water specific, should be general
4 participants