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

[DOCS] Clarify the Contributing UpdateImports documentation with CL-specific examples. #2388

Open
lubianat opened this issue Jun 5, 2024 · 2 comments

Comments

@lubianat
Copy link
Contributor

lubianat commented Jun 5, 2024

Motivated by some discussions on Slack, including these key comments (registered here for future reference:

By @rays22
The SOP could use an update by tailoring it to commonly used OBO ontology ODK workflows, so that if you know how to update a typical OBO/ODK ontology then the process should be very similar and not divergent for a specific ontology like CL.
Have you tried

cd [PATH_TO]/cell-ontology/src/ontology
sh run.sh make refresh-merged

to update the imports? The steps prior to this (i.e. prior to the ‘Using the Base Module approach’ section of the SOP) depend on how you declare the terms (e.g. adding a new term to cell-ontology/src/ontology/imports/uberon_terms.txt) you want to be imported.

@aleixpuigb
The fastest and easiest way to import terms is the protege-based declaration. You can then use the term without refreshing. I normally import by adding the terms in the specific file and then refresh.

and by myself:

The guidelines for imports in CL
https://obophenotype.github.io/cell-ontology/odk-workflows/UpdateImports/
seem to be mostly copied and pasted from
https://oboacademy.github.io/obook/howto/update-import/
Maybe it needs some revision to show the proceedings done by cl editors + have a link to the general OBO workflow?

#1853

@anitacaron
Copy link
Contributor

Here's the documentation specific to CL https://obophenotype.github.io/cell-ontology/Adding_classes_from_another_ontology/

lubianat added a commit that referenced this issue Jun 5, 2024
Related to #2388

* Clarifies the language on the contributing file

* Reduces and adapts to UpdateImports to CL

* Adds link to general OBO Training docs

Of note,  I haven't changed the "Refresh reports" bit as I lack experience on that front.
@lubianat
Copy link
Contributor Author

lubianat commented Jun 5, 2024

@anitacaron oh thanks!!! I only saw that now. Maybe we need to link that in "contributing".

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

No branches or pull requests

2 participants