Skip to content

Commit 8efeca6

Browse files
committed
Add create-ecc skill (research-first) and document it
Today: scaffolds one schema-valid, evidence-backed characteristic from a research brief and validates it with ecc-cli check. Next iteration (see #12): map characteristics to CC4K terms as computable logical definitions so sample classification updates automatically as knowledge evolves (WHO CNS4 -> CNS5).
1 parent c449778 commit 8efeca6

2 files changed

Lines changed: 30 additions & 77 deletions

File tree

README.md

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,36 @@ cargo build --release
2020
cargo run --release --example
2121
```
2222

23-
## 🧩 Scaffolding a new ECC
24-
25-
This repository ships a local [Claude Code](https://github.com/anthropics/claude-code)
26-
skill, `create-ecc`, that scaffolds a new composable characteristic as a
27-
schema-valid YAML file. It lives at
28-
[`.claude/skills/create-ecc/SKILL.md`](.claude/skills/create-ecc/SKILL.md) and
29-
mirrors the data model in `crates/ecc/src/`.
30-
31-
Given a description of a characteristic, the skill picks the correct folder
32-
(`ecc/morph` or `ecc/molec`) and identifier type (`ECC-MORPH-NNNNNN` /
33-
`ECC-MOLEC-NNNNNN`, uppercase with six zero-padded digits), keeps the filename
34-
number in sync with the identifier, writes the appropriate `state`
35-
(`draft`/`proposed`/`provisional`/`adopted`) and its required fields, and defines
36-
the value kind (`binary`, `categorical`, or `numerical`). It then validates the
37-
result with the checker below.
38-
39-
```text
40-
# In Claude Code, invoke the skill:
41-
/create-ecc add a molecular characteristic for MYCN amplification (binary: amplified vs not)
42-
43-
# It produces, for example, ecc/molec/000002-mycn-amplification.yml, then runs
44-
# the checker from the repo root (the Cargo workspace lives in `crates/`):
45-
cargo run --manifest-path crates/Cargo.toml -p ecc-cli -- check ecc
23+
## 🤖 Authoring characteristics with Claude
24+
25+
This repository ships a [Claude Code][claude-code] skill, `create-ecc`, that
26+
guides an agent through **researching and authoring** a new composable
27+
characteristic — not just writing YAML, but producing an evidence-backed entry a domain expert would sign off on. It lives at `.claude/skills/create-ecc/SKILL.md` and is discovered automatically by any agent started in this repository.
28+
29+
### What it does
30+
31+
1. **Research first.** Before writing anything, the agent builds an evidence
32+
brief: a precise definition and scope, the correct category (`morph` vs
33+
`molec`), primary-literature citations with resolvable URLs, how the property is measured/reported (which decides binary vs. enumerated values and any thresholds), and alignment with existing ontologies (NCIt/MONDO). A quality bar rejects thin or unsourced entries.
34+
2. **Scaffold correctly.** It allocates the next identifier
35+
(`ECC-{MORPH|MOLEC}-NNNNNN`, six zero-padded digits) and a matching
36+
`NNNNNN-slug.yml` filename in the right folder, and writes a schema-valid entry
37+
honoring the `state` lifecycle (`draft``proposed``provisional`
38+
`adopted`) and `deny_unknown_fields`.
39+
3. **Validate.** It runs `cargo run -p ecc-cli -- check ecc` and fixes any
40+
failures before finishing.
41+
42+
### Usage
43+
44+
Start an agent in the repository root and describe the characteristic, e.g.:
45+
46+
> Use the create-ecc skill to add a molecular characteristic for MYCN
47+
> amplification.
48+
49+
See [`.claude/skills/create-ecc/SKILL.md`](.claude/skills/create-ecc/SKILL.md)
50+
for the full workflow and schema reference.
51+
52+
[claude-code]: https://www.anthropic.com/claude-code
4653
```
4754
4855
## 🚧️ Tests

ecc/molec/000002-mycn-amplification.yml

Lines changed: 0 additions & 54 deletions
This file was deleted.

0 commit comments

Comments
 (0)