proteomics-sample-metadata icon indicating copy to clipboard operation
proteomics-sample-metadata copied to clipboard

Update README.adoc

Open ypriverol opened this issue 1 year ago • 2 comments

ypriverol avatar Oct 01 '24 13:10 ypriverol

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Documentation Update
The PR adds Mondo Disease Ontology (MONDO) to the list of supported ontologies/controlled vocabularies. Reviewer should verify if this addition is correct and if any related documentation or code changes are needed.

qodo-code-review[bot] avatar Oct 01 '24 13:10 qodo-code-review[bot]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Score
Enhancement
✅ Add a brief description of the newly added ontology to provide context

Consider adding a brief description or explanation of the Mondo Disease Ontology
(MONDO) to provide context for users who may not be familiar with it. This can help
readers understand its relevance and importance in the list of supported ontologies.

sdrf-proteomics/README.adoc [118]

-+- Mondo Disease Ontology (MONDO)
++- Mondo Disease Ontology (MONDO): A unified disease ontology integrating multiple disease resources

[Suggestion has been applied]

Suggestion importance[1-10]: 7

Why:

7
Best practice
✅ Adjust the formatting to maintain consistency with the existing list style

To maintain consistency with the existing list format, consider adding a hyphen (-)
at the beginning of the new line for the Mondo Disease Ontology. This will ensure
that the new entry matches the style of the other items in the list.

sdrf-proteomics/README.adoc [118]

-+- Mondo Disease Ontology (MONDO)
++	- Mondo Disease Ontology (MONDO)

[Suggestion has been applied]

Suggestion importance[1-10]: 7

Why:

7

💡 Need additional feedback ? start a PR chat

qodo-code-review[bot] avatar Oct 01 '24 13:10 qodo-code-review[bot]

Walkthrough

The changes involve updates to multiple documentation files within the SDRF-Proteomics project. The README.adoc file has been enhanced by adding the Mondo Disease Ontology (MONDO) to the supported ontologies section and introducing a new section on technology type. Additionally, the README.adoc in the templates directory has been modified to clarify sample metadata templates and experiment types. The .gitignore file has also been updated to include new patterns for ignored files and directories.

Changes

File Path Change Summary
sdrf-proteomics/README.adoc Added Mondo Disease Ontology (MONDO) and new "Technology type" section.
.gitignore Added .vscode/ and new_path/ to ignored files and directories.
templates/README.adoc Expanded sample metadata templates section and clarified experiment types.

Poem

In the garden of science, we grow,
With MONDO now added, our knowledge will flow.
Ontologies flourish, like flowers in bloom,
Enhancing our research, dispelling the gloom.
With each little change, our data takes flight,
A hop towards clarity, in the soft moonlight. 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between cfa8be3673d3f63dd42e018e4199fecac8296909 and 5b5f5e2a0dd4657888d444468a4a03943958b10f.

📒 Files selected for processing (1)
  • sdrf-proteomics/README.adoc (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • sdrf-proteomics/README.adoc

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Oct 11 '24 08:10 coderabbitai[bot]

My main question is about the MONDO ontology. It's not immediately clear to me, does it include all of the EFO terms about disease? Can there be conflicts because of this change? What do we need to do in the validator to support it?

The other comment is about technology type terms, I suggest to directly list the ones we should use in proteomics.

  • For the validator, this only means that we will look for diseases now in MONGO and EFO.
  • The URL of the technology type is not available yet because it needs to be indexed in OLS. I will also update the terms as you suggested in the specification because it will not be a long list.

ypriverol avatar Oct 11 '24 12:10 ypriverol

This looks good except for a small typo. Also about the term: I found it in the PRIDE ontology here. but in the current annotations there are also occurrences of "proteomic profiling by mass spectrometry", which sounds even more natural. I don't see any synonyms in the ontology, so I guess "mass spectrometry" is now technically incorrect? Do you want to add these synonyms to the ontology? (maybe also "proteomics profiling", that would be 4 options though)

  • The terms were added last night, but still need to be indexed in OLS.
  • The term added is:
[Term]
id: PRIDE:0000664
name: proteomic profiling by mass spectrometry
def: "An assay where proteins in a sample are detected, quantified or otherwise analysed using mass spectrometry" [EFO:EFO_0002766]
is_a: PRIDE:0000663 ! technology type

Which is also in EFO and other ontologies but now we are controlling in PRIDE. I will update the term in my side to proteomic profiling by mass spectrometry

ypriverol avatar Oct 11 '24 14:10 ypriverol

Should we also change it to "mass spectrometry" in all annotations then?

levitsky avatar Oct 11 '24 14:10 levitsky

Should we also change it to "mass spectrometry" in all annotations then?

I will after we agree on this PR ;)

ypriverol avatar Oct 11 '24 14:10 ypriverol