number_antibody
Find antibody and T-cell-receptor variable domains in a protein sequence, number them under IMGT, Kabat, Chothia, Martin, AHo or Wolfguy, call chain type and species, and assign the closest V and J germline with percent identity. Validated against ANARCI 2026.2.13.2 on every chain of its PDB benchmark.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| scheme | No | numbering scheme. Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), martin (Martin (enhanced Chothia)), aho (AHo), wolfguy (Wolfguy). | imgt |
| protein | Yes | the protein sequence (one-letter amino acids); may hold several domains, e.g. an scFv. | |
| species | No | species whose HMMs are preferred for the hit and whose germlines are searched (ANARCI's default: human and mouse). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| chainTypes | No | chain types to number: H, K, L (antibody); A, B, G, D (TCR). Others are still listed in the hit table. | |
| cdrDefinition | No | where CDR1-3 begin and end (abnumber's borders; North is read in Chothia numbering). Kabat, Chothia and North define H, K and L chains only; TCR domains keep IMGT's. Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), north (North). | imgt |
| assignGermline | No | assign the closest V and J germline genes. | |
| bitScoreThreshold | No | minimum HMMER bit score for a domain to count (ANARCI's default 80). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hits | Yes | every HMM hit over the threshold: id, E-value, bit score, start, end | |
| domains | Yes | one entry per domain: chain type, species, sequence span, numbering as [position, residue] pairs, framework and CDR regions (0-based residue spans) under cdrDefinition, germlines | |
| chainTypes | Yes | the chain type of each domain, in sequence order |