codon_table_fetch
Fetch a real codon-usage table for an organism and save it into this project, so later steps can score against it by name.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | which CDS set to count. `heg` uses the highly-expressed-gene set, which is what CAI and Fop reference tables are conventionally built from; `genome` counts every annotated CDS, which describes the organism's average gene rather than its best-expressed one. Values: heg (Highly-expressed genes — the CAI/Fop convention), genome (Whole genome — every annotated CDS). Only applies when source is ncbi. | heg |
| _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. | |
| source | No | which register to build the table from. `ncbi` counts the CDS of a RefSeq assembly and covers any organism with one; `kazusa` serves a published table and covers only the organisms its mirror bundles. Values: ncbi (NCBI RefSeq — counted from annotated CDS, any organism), kazusa (Kazusa/CUTG mirror — published table, bundled organisms only). | ncbi |
| save_as | No | the name to save the table under, as `table` on the other codon tools will spell it. Defaults to the resolved organism plus the basis, which is what the panel names it. | |
| _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. | |
| coverage | No | how much of a multi-replicon assembly to download. `complete` takes every replicon; `budgeted` takes the largest ones that fit a memory budget and SAYS which it used. The panel defaults to complete and falls back when the browser cannot hold the whole thing. Values: complete (Complete assembly), budgeted (Budgeted — largest replicons that fit). Only applies when source is ncbi. | complete |
| organism | Yes | the organism: a scientific name ("Saccharomyces cerevisiae") or an NCBI taxonomy id ("4932"). Resolved live against NCBI — no allow-list (§1 r4) — and the assembly it picks comes back in `report.builtFrom`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cds | Yes | how many CDS the table was counted from — the reference-set size, and the number a thin table is thin by. Absent on a register that publishes no counts | |
| gc3 | Yes | GC at the third codon position (%), the usage fingerprint. NCBI only; absent elsewhere | |
| table | Yes | the saved name — wire this straight into `table` on codon_usage_analysis or codon_optimality | |
| codons | Yes | total codons counted, the weight behind every frequency. ABSENT when the register publishes frequencies rather than counts (the Kazusa mirror does) — never 0, which would be a number you could quote | |
| report | Yes | the full provenance: register, resolved organism, the identifier the table was built from, and any coverage fallback | |
| organism | Yes | the organism as the register resolved it, which may be more specific than asked |