-
Notifications
You must be signed in to change notification settings - Fork 49
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
Update textual_definitions_SOP.md #2640
base: master
Are you sure you want to change the base?
Conversation
|
||
Here are a couple of examples of minimal definitions that are correct but not useful to most users: | ||
|
||
1. We could minimally define a corneal endothelial cell as 'Any endothelial cell that is part of the cornea'. This may well be sufficient for an expert in the anatomy and biology of the cornea, but to most biologists, the term "endothelial cell" brings to mind the principal cell types of lymphatic or blood vessels. However, "corneal endothelium" refers to a monolayer of flat cells on the underside of the cornea. | ||
2. Similarly, a perfectly accurate minimal definition of a type II pneuomocyte is an epithelial cell that has an 'alveolar lamellar body' (a unique structure only found in these cell types). But this is useless information to a user who knows nothing about this structure (many biologists) or who is annotating data that does not resolve this structure. | ||
We could minimally define a corneal endothelial cell as 'Any endothelial cell that is part of the cornea'. This may well be sufficient for an expert in the anatomy and biology of the cornea, but to most biologists, the term ""endothelial cell"" brings to mind the principal cell types of lymphatic or blood vessels. However, ""corneal endothelium"" refers to a monolayer of flat cells on the underside of the cornea. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason for the double double-apostrophes? In the next paragraphs only single apostrophes are used.
1. We could minimally define a corneal endothelial cell as 'Any endothelial cell that is part of the cornea'. This may well be sufficient for an expert in the anatomy and biology of the cornea, but to most biologists, the term "endothelial cell" brings to mind the principal cell types of lymphatic or blood vessels. However, "corneal endothelium" refers to a monolayer of flat cells on the underside of the cornea. | ||
2. Similarly, a perfectly accurate minimal definition of a type II pneuomocyte is an epithelial cell that has an 'alveolar lamellar body' (a unique structure only found in these cell types). But this is useless information to a user who knows nothing about this structure (many biologists) or who is annotating data that does not resolve this structure. | ||
We could minimally define a corneal endothelial cell as 'Any endothelial cell that is part of the cornea'. This may well be sufficient for an expert in the anatomy and biology of the cornea, but to most biologists, the term ""endothelial cell"" brings to mind the principal cell types of lymphatic or blood vessels. However, ""corneal endothelium"" refers to a monolayer of flat cells on the underside of the cornea. | ||
Similarly, a perfectly accurate minimal definition of a type II pneumocyte is an epithelial cell that has an 'alveolar lamellar body' (a unique structure only found in these cell types). But this is useless information to a user who knows nothing about this structure (many biologists) or who is annotating data that does not resolve this structure. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similarly, a perfectly accurate minimal definition of a type II pneumocyte is an epithelial cell that has an 'alveolar lamellar body' (a unique structure only found in these cell types). But this is useless information to a user who knows nothing about this structure (many biologists) or who is annotating data that does not resolve this structure. | |
Similarly, a perfectly accurate minimal definition of an 'pulmonary alveolar type 2 cell' is an epithelial cell that has an 'alveolar lamellar body' (a unique structure only found in these cell types). But this is useless information to a user who knows nothing about this structure (many biologists) or who is annotating data that does not resolve this structure. |
We could minimally define a corneal endothelial cell as 'Any endothelial cell that is part of the cornea'. This may well be sufficient for an expert in the anatomy and biology of the cornea, but to most biologists, the term ""endothelial cell"" brings to mind the principal cell types of lymphatic or blood vessels. However, ""corneal endothelium"" refers to a monolayer of flat cells on the underside of the cornea. | ||
Similarly, a perfectly accurate minimal definition of a type II pneumocyte is an epithelial cell that has an 'alveolar lamellar body' (a unique structure only found in these cell types). But this is useless information to a user who knows nothing about this structure (many biologists) or who is annotating data that does not resolve this structure. | ||
|
||
A second use of ontologies is to encode knowledge in the form of useful formal links between ontology terms. For example, in CL, we record function and cell components via links to gene ontology terms, location via links to CL, and lineage via links to other CL terms. Not all of this information is particularly useful for recognizing a cell type, but it is of use to our users and so we often record it in CL using formal relationships. This is relevant to ontology definitions because it is good practice for formal and textual definitions to match, and textual definitions are the place we encode supporting references. It’s essential that textual definitions capture the assertions made in the formal relationships as closely as possible without becoming stilted and difficult to read. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A second use of ontologies is to encode knowledge in the form of useful formal links between ontology terms. For example, in CL, we record function and cell components via links to gene ontology terms, location via links to CL, and lineage via links to other CL terms. Not all of this information is particularly useful for recognizing a cell type, but it is of use to our users and so we often record it in CL using formal relationships. This is relevant to ontology definitions because it is good practice for formal and textual definitions to match, and textual definitions are the place we encode supporting references. It’s essential that textual definitions capture the assertions made in the formal relationships as closely as possible without becoming stilted and difficult to read. | |
A second use of ontologies is to encode knowledge in the form of useful formal links between ontology terms. For example, in CL, we record function and cell components via links to gene ontology terms, location via links to Uberon, and lineage via links to other CL terms. Not all of this information is particularly useful for recognizing a cell type, but it is of use to our users and so we often record it in CL using formal relationships. This is relevant to ontology definitions because it is good practice for formal and textual definitions to match, and textual definitions are the place we encode supporting references. It’s essential that textual definitions capture the assertions made in the formal relationships as closely as possible without becoming stilted and difficult to read. |
We could minimally define a corneal endothelial cell as 'Any endothelial cell that is part of the cornea'. This may well be sufficient for an expert in the anatomy and biology of the cornea, but to most biologists, the term ""endothelial cell"" brings to mind the principal cell types of lymphatic or blood vessels. However, ""corneal endothelium"" refers to a monolayer of flat cells on the underside of the cornea. | ||
Similarly, a perfectly accurate minimal definition of a type II pneumocyte is an epithelial cell that has an 'alveolar lamellar body' (a unique structure only found in these cell types). But this is useless information to a user who knows nothing about this structure (many biologists) or who is annotating data that does not resolve this structure. | ||
|
||
A second use of ontologies is to encode knowledge in the form of useful formal links between ontology terms. For example, in CL, we record function and cell components via links to gene ontology terms, location via links to CL, and lineage via links to other CL terms. Not all of this information is particularly useful for recognizing a cell type, but it is of use to our users and so we often record it in CL using formal relationships. This is relevant to ontology definitions because it is good practice for formal and textual definitions to match, and textual definitions are the place we encode supporting references. It’s essential that textual definitions capture the assertions made in the formal relationships as closely as possible without becoming stilted and difficult to read. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not all of this information is particularly useful for recognizing a cell type, but it is of use to our users and so we often record it in CL using formal relationships.
I don't agree, location and cell markers are useful to recognize a cell. I would remove this sentence as is repetitive with the previous sentences.
We could minimally define a corneal endothelial cell as 'Any endothelial cell that is part of the cornea'. This may well be sufficient for an expert in the anatomy and biology of the cornea, but to most biologists, the term ""endothelial cell"" brings to mind the principal cell types of lymphatic or blood vessels. However, ""corneal endothelium"" refers to a monolayer of flat cells on the underside of the cornea. | ||
Similarly, a perfectly accurate minimal definition of a type II pneumocyte is an epithelial cell that has an 'alveolar lamellar body' (a unique structure only found in these cell types). But this is useless information to a user who knows nothing about this structure (many biologists) or who is annotating data that does not resolve this structure. | ||
|
||
A second use of ontologies is to encode knowledge in the form of useful formal links between ontology terms. For example, in CL, we record function and cell components via links to gene ontology terms, location via links to CL, and lineage via links to other CL terms. Not all of this information is particularly useful for recognizing a cell type, but it is of use to our users and so we often record it in CL using formal relationships. This is relevant to ontology definitions because it is good practice for formal and textual definitions to match, and textual definitions are the place we encode supporting references. It’s essential that textual definitions capture the assertions made in the formal relationships as closely as possible without becoming stilted and difficult to read. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is relevant to ontology definitions because it is good practice for formal and textual definitions to match, and textual definitions are the place we encode supporting references.
I think separating the sentences would improve readability. The second sentence can even go at the end of the paragraph:
This is relevant to ontology definitions because it is good practice for formal and textual definitions to match. Textual definitions also provide a place to include supporting references.
|
||
A second use of ontologies is to encode knowledge in the form of useful formal links between ontology terms. For example, in CL we record function and cell components via links to gene ontology terms, location via links to CL and lineage via links to other CL terms. Not all of this information is particularly useful for recognising a cell type, but it is of use to our users and so we often record it in CL using formal relationships. This is relevant to ontology definitions because it is good practise for formal and textual definitions to match, and textual definitions are the place we encode supporting references. | ||
#### **Definition** | ||
Text in the definition field should be no longer than one short paragraph. The text should be referenced following standard academic practice, i.e. use in-line citations, e.g., Avola et al., 2024). It should follow a classic genus, differentia, and gloss type structure: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Text in the definition field should be no longer than one short paragraph. The text should be referenced following standard academic practice, i.e. use in-line citations, e.g., Avola et al., 2024). It should follow a classic genus, differentia, and gloss type structure: | |
Text in the definition field should be no longer than one short paragraph. The text should be referenced following standard academic practice, i.e. use in-line citations (e.g., Avola et al., 2024). It should follow a classic genus, differentia, and gloss type structure: |
|
||
### SOP | ||
**Guidelines on Content Inclusion**: | ||
-**Do not include the name of the cell type being defined at the start of the definition.** Instead, the genus cell type should be named here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-**Do not include the name of the cell type being defined at the start of the definition.** Instead, the genus cell type should be named here. | |
- **Do not include the name of the cell type being defined at the start of the definition.** Instead, the genus cell type should be named here. |
|
||
Some cell types are defined with reference to transcriptomic data. This is especially common in brain datasets. In these cases, naming is often based on semi-automated transfer of names that are based on some specific set of properties. We do not always know how widely those properties apply so need to be careful in choosing them for differentia. Extended multi-modal descriptions may be available, for example based on patch-seq data, but this is typically derived from very sparse data, so such information belongs in the extended definition, along with details of the brain regions where these properties have been assayed. | ||
### **Defining Transcriptomic Types (t-types)**: | ||
Some cell types are defined with reference to transcriptomic data. This is especially common in brain datasets. In these cases, naming is often based on semi-automated transfer of names that are based on some specific set of properties. We do not always know how widely those properties apply, so we need to be careful in choosing them for differentia. Extended multi-modal descriptions may be available, for example, based on patch-seq data, but this is typically derived from very sparse data, so such information belongs in the extended definition, along with details of the brain regions where these properties have been assayed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some cell types are defined with reference to transcriptomic data. This is especially common in brain datasets. In these cases, naming is often based on semi-automated transfer of names that are based on some specific set of properties. We do not always know how widely those properties apply, so we need to be careful in choosing them for differentia. Extended multi-modal descriptions may be available, for example, based on patch-seq data, but this is typically derived from very sparse data, so such information belongs in the extended definition, along with details of the brain regions where these properties have been assayed. | |
Some cell types are defined with references to transcriptomic data. This is especially common in brain datasets. In these cases, naming is often based on semi-automated transfer of names that are based on some specific set of properties. We do not always know how widely those properties apply, so we need to be careful in choosing them for differentia. Extended multi-modal descriptions may be available, for example, based on patch-seq data, but this is typically derived from very sparse data, so such information belongs in the extended definition, along with details of the brain regions where these properties have been assayed. |
label: | ||
A transcriptomically distinct intratelencephalic-projecting glutamatergic neuron with a soma found between cortical layer 2-4. The standard transcriptomic reference data for this cell type can be found on the CellxGene census under the collection: "Transcriptomic cytoarchitecture reveals principles of human neocortex organization", dataset: "Supercluster: IT-projecting excitatory neurons", Author Categories: "CrossArea_subclass", value: L2/3 IT. | ||
**Example**: | ||
Label: A transcriptomically distinct intratelencephalic-projecting glutamatergic neuron with a soma found between cortical layer 2-4. The standard transcriptomic reference data for this cell type can be found on the CellxGene census under the collection: ""Transcriptomic cytoarchitecture reveals principles of human neocortex organization"", dataset: ""Supercluster: IT-projecting excitatory neurons"", Author Categories: ""CrossArea_subclass"", value: L2/3 IT. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the Label is missing, and this paragraph should be definition. The double double-apostrophes are present again. Also, Comment is in bold, but label is not. I would not capitalize to differentiate with NOTE later.
|
||
Given the limited knowledge we have about how and whether they are unique to a particular cell type, care needs to be taken in adding formal axioms recording them. Where there is a possibility that it is important to limit clauses in EquivalentClass expressions. | ||
Given the limited knowledge we have about how and whether they are unique to a particular cell type, care needs to be taken in adding formal axioms recording them. Where there is a possibility that it is important to limit clauses in EquivalentClass expressions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't understand the second sentence, is something missing?
This PR has not seen any activity in the past month; if nobody comments or reviews it in the next week, the PR editor will be allowed to proceed with merging without explicit approval, should they wish to do so. |
Fixes #2556
Fixes #2385
Still to fix: Advice on extended descriptions for T-types.