score_overhang_fidelity
Score a Golden Gate junction (fusion-site) set against MEASURED T4 DNA ligase end-joining data. It is the number NEB's Ligase Fidelity Viewer reports: the expected fraction of assemblies in which EVERY junction ligated correctly. This is the quantitative counterpart to check_golden_gate_parts: that says whether the parts will be cut, this says whether the pieces will go back together in the right order. Wire golden_gate_assemble's overhangs output straight into it.
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. | |
| enzyme | No | the Type-IIS enzyme the reaction uses, which picks that enzyme's own measured matrix when one exists. Only applies when dataset is not given. | |
| dataset | No | score against this measured matrix instead of the one the enzyme implies. Values: BsaI-HFv2 (BsaI-HFv2, Golden Gate cycling (4 nt)), BsmBI-v2 (BsmBI-v2, Golden Gate cycling (4 nt)), Esp3I (Esp3I, Golden Gate cycling (4 nt)), BbsI-HF (BbsI-HF, Golden Gate cycling (4 nt)), SapI (SapI, Golden Gate cycling (3 nt)), T4-01h-25C (T4 DNA ligase, 1 h at 25 C (4 nt)), T4-01h-37C (T4 DNA ligase, 1 h at 37 C (4 nt)), T4-18h-25C (T4 DNA ligase, 18 h at 25 C (4 nt)), T4-18h-37C (T4 DNA ligase, 18 h at 37 C (4 nt)). | |
| _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. | |
| remedies | No | also compute what to CHANGE: the drop-the-worst repair, and replacement candidates for each flagged junction. Off makes the run cheaper on a large set. | |
| overhangs | Yes | the junction overhangs, one per junction, top strand (e.g. AATG, GCTT). Wire `golden_gate_assemble.overhangs` here, or list them. | |
| replacements_per_junction | No | how many replacement candidates to rank per flagged junction. Advanced. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| flags | Yes | weak, self-misannealing and cross-misannealing junction indices, plus the structural verdict | |
| worst | Yes | the weakest junctions, worst first: what to change to raise the score | |
| repair | Yes | the drop-the-worst repair: which junctions to remove, what is left, and the fidelity that leaves. Null when `remedies` is off | |
| dataset | Yes | the measured matrix actually scored against | |
| percent | Yes | the same number as a percentage, which is how every incumbent reports it | |
| fidelity | Yes | expected fraction of fully-correct assemblies, 0-1 | |
| junctions | Yes | per junction: overhang, correct/total measured events, its own fidelity, Watson-Crick strength, and its strongest mismatch partners | |
| meaningful | Yes | false when a STRUCTURAL error makes the fidelity number misleading rather than merely bad: do not present `fidelity` on its own when this is false | |
| replacements | Yes | per FLAGGED junction, the best overhangs to swap in, each with the whole set’s fidelity after the swap. Empty when `remedies` is off | |
| atMeasurementCeiling | Yes | true when NO mismatch ligation was measured between any two junctions, so the score is exactly 100%: the floor the source experiment can resolve, not a guarantee |