Skip to content

docs: add TraitDefinition and ebv_glossary API reference #82

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.

Sign up for GitHub

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

Merged
zircote merged 1 commit into from
Feb 20, 2026
Merged

docs: add TraitDefinition and ebv_glossary API reference #82

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/reference/LIBRARY-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,16 @@ Pure computation functions for breeding analytics with no external dependencies.
| `score` | `f64` | Weighted composite score |
| `trait_scores` | `HashMap<String, f64>` | Per-trait weighted scores |

**`TraitDefinition`** — EBV trait metadata with interpretation and selection direction.

| Field | Type | Description |
|-------|------|-------------|
| `abbreviation` | `&'static str` | Trait abbreviation (e.g., `"BWT"`) |
| `name` | `&'static str` | Full trait name (e.g., `"Birth Weight"`) |
| `unit` | `&'static str` | Unit of measurement (e.g., `"lbs"`) |
| `description` | `&'static str` | What the trait measures |
| `selection_direction` | `&'static str` | Whether higher or lower is better |

#### Functions

**`calculate_coi(sire_lineage: &Lineage, dam_lineage: &Lineage) -> CoiResult`**
Expand Down Expand Up @@ -735,6 +745,25 @@ for ancestor in shared {
# }
```

**`ebv_glossary() -> Vec<TraitDefinition>`**

Returns complete glossary of all 13 NSIP EBV traits with metadata for each trait.

```rust
use nsip::mcp::analytics::ebv_glossary;

for trait_def in ebv_glossary() {
println!("{} ({}): {} [{}]",
trait_def.abbreviation,
trait_def.name,
trait_def.description,
trait_def.selection_direction
);
}
```

See [EBV Trait Glossary](../MCP.md#ebv-trait-glossary) for the complete trait reference table.

---

### prompts Submodule
Expand Down
Loading