You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: document ID allocation and deprecation workflow in README
Replaces stale section pointing at metadata/historical_usage_analysis/
with accurate description of:
- deprecated.tsv (ROBOT template, committed, built into every release)
- make audit-ids (regenerates reports/id-allocation-audit.md)
- the no-ID-reuse policy
Also adds id-allocation-audit.md to the Key Documentation list.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+14-7Lines changed: 14 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -170,19 +170,25 @@ make all-reports
170
170
-`reports/madin-metpo-reconciliation.yaml`
171
171
-`reports/synonym-sources.tsv`
172
172
173
-
### 5. Historical ID Tracking (`metadata/historical_usage_analysis/`)
173
+
### 5. ID Allocation and Deprecation
174
174
175
-
Track METPO entity stability and IRI evolution across BioPortal submissions.
175
+
METPO has gone through three numbering eras. All IDs ever used — across current templates,
176
+
historical BioPortal submissions, and tagged releases — are tracked to prevent reuse.
176
177
177
178
```bash
178
-
#Download historical submissions
179
-
make download-all-bioportal-submissions
179
+
#Regenerate the id allocation audit report
180
+
make audit-ids # writes reports/id-allocation-audit.md
180
181
181
-
# Extract entities from each version
182
-
make extract-all-metpo-entities
182
+
# Regenerate the deprecated terms OWL component
183
+
make -C src/ontology -f metpo.Makefile regenerate-deprecated
184
+
# or just let the normal build pick it up:
185
+
make -C src/ontology -f metpo.Makefile components/metpo_sheet.owl
183
186
```
184
187
185
-
Analyzes IRI numbering scheme changes, entity additions/removals, and ID reuse violations. See `metadata/historical_usage_analysis/README.md` for comprehensive findings.
188
+
`src/templates/deprecated.tsv` is a ROBOT template that marks every burned ID as
189
+
`owl:deprecated true` with an `"obsolete ..."` label. It is committed to the repo and
190
+
merged into `metpo.owl` during every release build. **Never reuse a burned ID** — consult
191
+
`reports/id-allocation-audit.md` for the full list and the next safe IDs to allocate.
186
192
187
193
### 6. Ontology Alignment Pipeline (`notebooks/`)
188
194
@@ -228,6 +234,7 @@ make notebooks/non-ols-terms/D3O.tsv
0 commit comments