Skip to content

Commit 5d01f90

Browse files
committed
Update copilot-instructions.md
1 parent 3af04fc commit 5d01f90

1 file changed

Lines changed: 21 additions & 27 deletions

File tree

.github/copilot-instructions.md

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
This includes instructions for editing the OBA ontology.
44

55
## Project Layout
6-
- Main development file is `src/ontology/oba-edit.obo`
6+
- Main development file is `src/patterns/definitions.owl` (functional syntax)
77
- ODK and ontology documentation can be found in `/docs/`
88

99
## Querying ontology
1010

1111
- To look at a specific term if you know the ID:
12-
- `obo-grep.pl -r 'id: OBA:2040177' src/ontology/oba-edit.obo`
12+
- `obo-grep.pl -r 'id: OBA_2040177' src/patterns/definitions.owl`
1313
- All mentions of an ID
14-
- `obo-grep.pl -r 'OBA:2040177' src/ontology/oba-edit.obo`
14+
- `obo-grep.pl -r 'OBA_2040177' src/patterns/definitions.owl`
1515
- Note that `obo-grep.pl` is in your PATH, no need to search for it
16-
- Only search over `src/ontology/oba-edit.obo`
16+
- Only search over `src/patterns/definitions.owl`
1717
- DO NOT bother doing your own greps over the file, or looking for other files, unless otherwise asked, you will just waste time.
1818
- ONLY use the methods above for searching the ontology
1919

@@ -28,41 +28,42 @@ This includes instructions for editing the OBA ontology.
2828
### How to create new terms in OBA
2929

3030
#### Overview
31-
- IMPORTANT: Do not edit the edit file directly, it's large
3231
- OBA terms are compositional, check DOSDP design patterns: `src/patterns/dosdp-patterns/*.yaml`
3332
- Desgin pattern templates are found in `src/patterns/data/default`
3433

3534
#### Steps
3635

37-
1- Read the issue carefully to identify design pattern filler terms.
36+
1- Read the issue carefully to identify the most appropriate design pattern and filler terms. Use the following examples as a general guide.
3837

39-
Example:
40-
41-
```
42-
```
38+
Example 1: The amount or level of cholesterol when measured in blood serum. Use the design pattern template `entity_attribute_location.tsv` and the filler terms: cholesterol, amount and blood serum.
39+
40+
Example 2: The age at which asthma manifestations first appear. Use the design pattern template `disease_onset.tsv` and the filler term: asthma.
4341

44-
2- Check whether design pattern components have been imported to OBA. Search `src/ontology/imports/merged_import.owl`
42+
Example 3: A trait that affects the response to prednisolone. Use the design pattern template `response_to_chemical_stimulus_trait.tsv` and the filler term: prednisolone.
43+
44+
2- Check whether design pattern fillers have been imported to OBA. Search `src/ontology/imports/merged_import.owl`
4545

46-
3- If they do, please proceed to creating the new OBA term using the appropriate DOSDP pattern template.
46+
3- If they have been imported, please proceed to creating the new OBA term using the appropriate DOSDP pattern template.
4747

4848
4- Add the term to the template, then run
49-
sh run.sh make IMP=false MIR=false ../patterns/definitions.owl
49+
make IMP=false MIR=false ../patterns/definitions.owl
5050

5151
5- Refresh OBA imports by running
52-
sh run.sh make refresh-merged
53-
54-
6 - Run sh run.sh make IMP=false MIR=false ../patterns/definitions.owl again.
52+
make refresh-merged
5553

56-
7- When creating new OBA terms using DOSDP patterns, it may be necessary to import terms from other ontologies like ChEBI, the Chemical Entities of Biological Interest or PRO, the PRotein Ontology. However, they are too large to be managed as standard imports so are managed as slims. When a new term you are using in a DOSDP pattern is not yet in a slim you will have to refresh the slim first. They are located here:
54+
6 - Run make IMP=false MIR=false ../patterns/definitions.owl again.
5755

56+
7- When creating new OBA terms using DOSDP patterns, it may be necessary to import terms from other ontologies like ChEBI, the Chemical Entities of Biological Interest or PRO, the PRotein Ontology. However, they are too large to be managed as standard imports so are managed as slims. They are located here:
5857
PRO: https://github.com/obophenotype/pro_obo_slim
5958
CHEBI: https://github.com/obophenotype/chebi_obo_slim
6059

60+
When a new term you are using in a DOSDP pattern is not yet in a slim, make a comment in the issue requesting the terms to be added manually.
61+
6162
## OBO Format Guidelines
6263
- Term ID format: OBA:NNNNNNN (7-digit number)
6364
- Handling New Term Requests (NTRs):
6465
- New terms start OBA:210xxxx
65-
- Do `grep id: OBA:210 src/ontology/oba-edit.obo` to check for clashes
66+
- Do `grep id: OBA:210 src/patterns/definitions.owl` to check for clashes
6667
- Each term requires: id, name, definition with references
6768
- Never guess OBA IDs, or ontology term IDs, use search tools above to determine actual term
6869
- Never guess PMIDs for references, do a web search if needed
@@ -102,15 +103,8 @@ This includes instructions for editing the OBA ontology.
102103
- Re-create the DOS-DP axioms by running
103104

104105
cd PATH-TO/bio-attribute-ontology/src/ontology
105-
sh run.sh make ../patterns/definitions.owl
106-
sh run.sh make components/obsoletes.owl
107-
108-
Example:
109-
110-
```
111-
[Term]
112-
113-
```
106+
make ../patterns/definitions.owl
107+
make components/obsoletes.owl
114108

115109
## Other metadata
116110

0 commit comments

Comments
 (0)