design_barcodes
Design a set of NGS sample-index barcodes with a guaranteed minimum distance, and report what that set actually corrects — substitutions, or indels too (DNABarcodes).
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. | |
| length | No | barcode length in bases. In bp. | |
| metric | No | error model. A set correcting one substitution may correct zero indels, so this choice is the design, not a display option. Values: hamming (Hamming (substitutions)), seqlev (Sequence-Levenshtein (indels)), levenshtein (Levenshtein), phaseshift (Phaseshift). | seqlev |
| _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. | |
| filter_gc | No | keep only balanced-GC barcodes (suppressed for length ≤ 3). Advanced. | |
| heuristic | No | set-construction strategy. Values: conway (Conway (greedy)), clique (Clique), sampling (Sampling), ashlock (Ashlock). | conway |
| min_distance | No | required minimum distance between any two barcodes — this is what buys the error correction. | |
| filter_triplets | No | reject barcodes containing a homotriplet (AAA…). Advanced. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | how many barcodes the search actually found | |
| analysis | Yes | the set's properties under EVERY metric, not just the design one | |
| barcodes | Yes | the designed set | |
| warnings | Yes | what the search had to say | |
| guarantee | Yes | correctable / detectable errors under the design metric |