Search arXiv papers, download full text, semantic search, citation graphs, and alerts via MCP.
Jean — Molecular Biology & Genomics is installed from its publisher's own source and answers where it runs, so this marketplace is not in the path of a single call. There is no address here to send one to, and a panel that pretended otherwise would be showing you an answer we made up. Install it and call it from your own client — the Installation tab has the entry for each one.
What it does
Validated molecular biology tools: cloning, primers, CRISPR, Sanger, alignment, qPCR, phylogenetics
Quickstart
# 1 — add it to Claude Code
claude mcp add --scope user --transport http jean-molecular-biology-genomics-mcp https://jeanslabs.vercel.app/mcp
# 2 — ask your agent for something these tools do
# list_workflow_templates, validate_workflow, run_workflow and 312 more
Jean — Molecular Biology & Genomics costs nothing on mcprush: there is no plan to choose here, no cap to set and nothing mcprush can bill you for.
Collected from a public index. Nobody has claimed this account, so nothing here was written by its author — claim it if it is yours.
Where are you running it?
Every route below installs the same thing and ends at the same approval screen. Nothing here runs on your machine and nothing runs on ours: this server answers at its publisher’s own address, and what you install is the connection straight to it.
This is a public server: it answers at its publisher’s own address and this marketplace is not in the path. Claude Code registers it in one command; --scope user makes it available in every project. The transport below is http, as the publisher's own manifest declares it.
claude mcp add --scope user --transport http jean-molecular-biology-genomics-mcp https://jeanslabs.vercel.app/mcpReconnect, or start a new session, and the tools appear in the model’s tool list.
One config entry pointing straight at the publisher’s own address — this marketplace is not in the path, and nothing from this listing executes on your machine.
315 tools, with what each one reads, writes and reaches shown before you agree — the same list on every route above. Read the tool surface.
Tool surface
What the model actually sees. Descriptions are diffed on every release — see version history.
The built-in starter workflows — id, name, what each does and which tools it chains. Pass an id to get that template’s graph back, ready to hand to run_workflow. This server is stateless, so these are the shipped templates only, not anything a person has saved in their own editor.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | string | no | one template id; omit for the whole listing |
Would this workflow graph run? Returns the blocking errors — an unknown tool, a wire into a port that does not exist, a cycle — each naming the node and the port, without running anything.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| graph | object | yes | A workflow graph: nodes naming tools, wires carrying one node’s output into another’s input, and the two constructs a single tool call cannot express — $whenExpression (run this node only if…) and ` |
| _subject | object | no | The record this call acts on, standing in for the document open in the editor. Exactly one of: sequence, file, sample, accession. This server holds no project, so a tool needing a subject gets |
| _files | array | no | The project's files, standing in for the project open in the editor: each is one record reference (a file, sample, accession or named sequence). Every sequence record they hold becomes a libra |
Run a workflow graph: nodes naming tools, wires carrying one node’s output into another’s input, $whenExpression to make a step conditional, and scatter to run a step once per element of a list. Returns the run record — per-node status, outputs and errors, in topological order.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| graph | object | yes | A workflow graph: nodes naming tools, wires carrying one node’s output into another’s input, and the two constructs a single tool call cannot express — $whenExpression (run this node only if…) and ` |
| _subject | object | no | The record this call acts on, standing in for the document open in the editor. Exactly one of: sequence, file, sample, accession. This server holds no project, so a tool needing a subject gets |
| _files | array | no | The project's files, standing in for the project open in the editor: each is one record reference (a file, sample, accession or named sequence). Every sequence record they hold becomes a libra |
Return the plasmid/sequence currently open in the editor. Emits it as a record, so it is the SOURCE node of a pipeline — wire its record into any downstream node's $subject.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| _subject | object | 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. |
| _files | array | 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. |
Read a CHOSEN project document as a record — the pipeline's data-reader source, for running on a specific file instead of whatever happens to be open in the editor. Wire its record into any downstream node's $subject.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | yes | the project document to read — its id, or its exact name (list_library lists them). |
| _subject | object | 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. |
| _files | array | 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. |
List the project's sequence documents (id, name, length, topology, kind).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | no | restrict to one document kind (all kinds when unset). Kind is derived from the record itself — amplicon is provenance, not a file property, so documents read from disk are never classified as one. |
| _subject | object | 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. |
| _files | array | 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. |
Cut positions of the given enzymes on the open plasmid (top/bottom cut, overhang, kind).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| enzymes | array | yes | enzyme names to scan for — resolved against the bundled cut catalog (REBASE spellings; smaller than the REBASE dossier the editor shows), e.g. EcoRI, BsaI. Left unset, the run uses your active enzyme |
| _subject | object | 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. |
| _files | array | 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. |
Where the given enzymes could ALSO cut the open plasmid under non-standard conditions, from REBASE's own star-activity list and its one-base rule. Not cut sites: these need low ionic strength, high pH, Mn²⁺ for Mg²⁺, glycerol, DMSO or some detergents, and are what turns an over-digested reaction into a band pattern that reads as the wrong clone.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| enzymes | array | yes | enzymes to check — resolved against the bundled cut catalog (REBASE spellings; smaller than the REBASE dossier the editor shows). Left unset, the run uses your active enzyme collection. |
| _subject | object | 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. |
| _files | array | 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. |
Whether the host's own methylation blocks the given enzymes ON THIS PLASMID, from REBASE's methylation-sensitivity tables localised onto your sites. The other term of the same reaction question find_star_sites answers. It is deliberately per-SITE and not per-enzyme: REBASE says Dam blocks ClaI, and pBR322's single ClaI site carries no overlapping GATC, so the enzyme-level warning does not apply
| Parameter | Type | Required | Notes |
|---|---|---|---|
| enzymes | array | yes | enzymes to check — resolved against the bundled cut catalog (REBASE spellings; smaller than the REBASE dossier the editor shows). Left unset, the run uses your active enzyme collection. |
| _subject | object | 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. |
| _files | array | 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. |
The reaction a digest needs, from NEB's own data: the NEBuffer that serves every enzyme together (scored on the WORST enzyme's percent activity, a star-activity buffer disqualified at any percent), the incubation temperature(s), any cofactor that must be added (SAM or ATP), and each product's heat-inactivation step, or the products NEB cannot heat-inactivate. One call is one tube: enzymes that nee
| Parameter | Type | Required | Notes |
|---|---|---|---|
| enzymes | array | yes | enzymes or NEB product names in one tube (EcoRI, BamHI-HF). A name NEB does not sell is returned under unknown, never dropped. Left unset, the run uses your active enzyme collection. |
| _subject | object | 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. |
| _files | array | 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. |
Per-enzyme cut counts on the open plasmid (the EcoRI² superscript-badge numbers).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| enzymes | array | yes | enzyme names to scope the scan to — resolved against the bundled cut catalog (REBASE spellings; smaller than the REBASE dossier the editor shows). Left unset, the run uses your active enzyme collectio |
| _subject | object | 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. |
| _files | array | 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. |
Render the open record's map to a publication SVG string, circular or linear — the same figure the Export panel draws, with the same knobs and the same defaults. Give it enzymes to draw the restriction sites. The linear layout can draw both strands' bases and a window of the record (start/end), which is the sequence view as a figure.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| title | string | no | figure title; left empty, the record's own name is used. |
| size | number | no | square canvas edge, before a legend strip is added below it. In px. |
| transparent | boolean | no | omit the backing rect, so the figure drops onto any ground. |
| show_labels | boolean | no | draw each feature's name beside its arc. |
| collapse_duplicate_labels | boolean | no | fold leader labels that would repeat a name into one row, as misc_binding ×13 — the same rule the interactive map uses. Off reproduces the upstream renderer's figure exactly, one leader per feature. |
| show_sites | boolean | no | draw the outer restriction-site ring. |
| legend | boolean | no | add a colour key on its own strip below the map. |
| font | string | no | figure font — one of the three stacks that survive an SVG-to-PDF conversion without substitution. |
| layout | string | no | circular: the ring; linear: the record unrolled into rows, features in lanes under a ruler and sites above it. |
| show_bases | boolean | no | linear only: draw both strands' bases over the ruler; rows wrap to keep each base readable. Only applies when layout is linear. |
| start | number | no | linear only: first base of the window to draw (1-based); left unset, the record's first base. In bp. Only applies when layout is linear. |
| end | number | no | linear only: last base of the window to draw (1-based, inclusive); left unset, the record's last base. In bp. Only applies when layout is linear. |
| enzymes | array | no | enzymes whose cut sites fill the site ring — resolved against the bundled cut catalog (REBASE spellings; smaller than the REBASE dossier the editor shows). Left unset, the run uses your active enzyme |
| _subject | object | 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. |
| _files | array | 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. |
Resolve a gel lane (ladder / plasmid / digest / pcr) into [bp, form] bands for the open plasmid.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | yes | what this lane holds. Values: ladder (DNA ladder), plasmid (Uncut plasmid), digest (Restriction digest), pcr (PCR product). |
| detail | string | no | for a ladder: its name; for a digest: comma-separated enzymes. Unused for plasmid/pcr lanes. Only applies when source is ladder or digest. |
| product_bp | number | no | for a pcr lane: the product length, e.g. the length of the record pcr_amplify emits. Required for a pcr lane. In bp. Only applies when source is pcr. |
| _subject | object | 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. |
| _files | array | 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. |
Run an agarose gel and photograph it: every lane's fragments migrated by the validated pydna model, drawn as a gel-doc image with the marker ladder's bp marks and each lane's name. The same plate the gel panels draw, so the figure and the rail put every fragment in the same place. Wire fragments from a digest or lengths from an assembly into lanes. A fragment the calibrating curve cannot pla
| Parameter | Type | Required | Notes |
|---|---|---|---|
| lanes | array | yes | the lanes, each {name, lengths: [bp, …]}. The marker lane is added for you — ladder chooses it. |
| ladder | string | no | the MW marker in the reference lane, which is also the curve every lane's migration is read off unless agarose_percent is set. Values: generuler_1kb_plus (GeneRuler 1 kb Plus (75–20,000)), hi_lo (Hi |
| agarose_percent | number | no | the gel's agarose (% w/v). Set it and migration comes from a concentration law instead of the ladder's own spline, so the gel responds to the percentage the way a real one does; leave it unset for the |
| mobility_model | string | no | which published mobility law the agarose % is applied through. Ignored unless agarose_percent is set. Values: helling-goodman-boyer (Helling-Goodman-Boyer), rill-van-winkle (Rill / Van Winkle). Only |
| dna_form | string | no | topology of the sample DNA: supercoiled and nicked circles do not migrate where a linear fragment of the same length does. Only the Helling-Goodman-Boyer law uses it. Values: linear (Linear), supercoi |
| stain | string | no | the dye the plate was stained with; its published emission maximum is the colour the bands are drawn in. Values: etbr (Ethidium bromide), sybr-safe (SYBR Safe), sybr-gold (SYBR Gold), gelred (GelRed). |
| exposure | string | no | Whole plate: brightness against the brightest band on the plate (a lightly loaded lane, the ladder included, can draw almost black); Per lane: brightness against each lane's own brightest band (bright |
| lane_width | number | no | how wide each lane is drawn. In px. Advanced. |
| labels | boolean | no | print the ladder's readable bp marks, each lane's number above its well and a legend naming it. Off gives the bare plate, for a figure that captions itself. |
| caption | boolean | no | the line under the plate naming the curve that positioned the bands and what their brightness is relative to. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Where a primer anneals on the open plasmid: 3'-anchored sites with identity % and the ✓/⚠/~/✗ verdict, graded at a bar you can move and that the answer states. The scan is 3'-anchored, so every site it reports matches the oligo's 3' seed exactly and 'no sites' means no seed match rather than a low score.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| primer | string | yes | primer sequence 5'→3'. |
| thresholds | object | no | the identity boundaries the ✓/⚠/~/✗ verdict is cut at. Left unset, the run uses the bar your Primer Library is set to, and with no panel state the upstream SpliceCraft default — either way the bar it |
| _subject | object | 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. |
| _files | array | 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. |
Lay a set of oligos out as a supplier's PLATE order sheet: one worksheet per plate, in the well order the supplier's own order form fills, with the column shape its loading direction requires. A plate order is addressed BY WELL, which a flat tube list cannot express — so this is the shape an oligo set actually gets ordered in once it outgrows a handful of tubes. With mixed, a forward and a rever
| Parameter | Type | Required | Notes |
|---|---|---|---|
| oligos | array | yes | the oligos to lay out, 5'→3'. Wire them from a design run, or list them. With mixed, these are read in FORWARD, REVERSE order — two entries per well. |
| names | array | yes | a name per oligo, in the same order. A plate well is ORDERED BY NAME, so an unnamed oligo is refused rather than numbered: the label is what the supplier ships the tube under. |
| format | number | no | wells per plate. Values: 96 (96 well), 384 (384 well). |
| fill | string | no | how the plate is loaded. It decides the FILE'S COLUMNS, not just the order: a plate filled by row or by column carries no well column at all, because the supplier derives each position from the row or |
| plate_name | string | no | the plate's name, which becomes the worksheet's name. Several plates get ' (2)', ' (3)' appended. |
| mixed | boolean | no | one well per PRIMER PAIR: oligos is read as forward, reverse, forward, reverse, and each plate is written as every well once carrying the forwards and again carrying the reverses. |
| pad_to_capacity | boolean | no | write every unused well as the supplier's blank-name, blank-sequence row rather than ending the sheet short. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Turn a record into the SUBMISSION SET NCBI's table2asn consumes: a .fsa whose defline carries the source modifiers, and a 5-column feature table (.tbl) beside it. This is not a GenBank export — GenBank's submission pipeline takes neither a .gb nor a plain fasta. Its real work is REFUSING and MIGRATING what GenBank will not accept: twelve feature keys were retired in 2014 in favour of `regu
| Parameter | Type | Required | Notes |
|---|---|---|---|
| genbank | string | yes | the record to submit, as GenBank text. Its features and topology are read from it — wire it from an export, or paste it. |
| collection_date | string | no | when the sample was collected. MANDATORY on every GenBank submission since December 2024. DD-Mmm-YYYY, Mmm-YYYY, YYYY, an ISO form, or two of them separated by / for a range. A construct that |
| geo_loc_name | string | no | where the sample came from: a country, ocean or sea from the INSDC vocabulary, optionally :region and , locality. MANDATORY since December 2024, and it takes the same missing-value terms. |
| organism | string | no | the scientific name of the source organism. synthetic construct is a real answer for a built vector, not an absence. |
| mol_type | string | no | one of INSDC's two MANDATORY qualifiers on the source key. Omitting it lets table2asn choose, which is a scientific fact picked by a tool. |
| topology | string | no | circular for a plasmid. With this omitted table2asn writes linear into the LOCUS line, so a plasmid is deposited as a linear molecule with no error anywhere. Left empty, the record's own topology is |
| _subject | object | 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. |
| _files | array | 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. |
Turn a record into what ENA's Webin-CLI takes for an annotated sequence (-context sequence): an ENA flat file (.embl) and its manifest. Features are checked against the tables ENA's own validator reads, so what Webin-CLI would refuse (an unknown key, a missing mandatory qualifier, a double quote in a value, a duplicate feature) is refused or rewritten here, by name. A description under 10 char
| Parameter | Type | Required | Notes |
|---|---|---|---|
| genbank | string | yes | the record to submit, as GenBank text. Its features, topology and DEFINITION are read from it. |
| study | string | no | the Webin Portal study accession (PRJEB… or ERP…). Webin-CLI refuses a set without one; left empty, the files are written and the reason reported. |
| description | string | no | the DE line, what the sequence is. Left empty, each record's own DEFINITION is used; ENA refuses one shorter than 10 characters. |
| collection_date | string | no | when the sample was collected, on the source feature. Optional, but must be INSDC-legal; a construct takes a missing-value term such as missing: lab stock. |
| geo_loc_name | string | no | where the sample came from, from the INSDC vocabulary, or a missing-value term. |
| organism | string | no | the scientific name of the source organism; ENA checks it against its taxonomy. synthetic construct is a real answer for a built vector. |
| mol_type | string | no | the source feature's mandatory /mol_type. other DNA is the INSDC value for a synthetic construct. |
| topology | string | no | circular for a plasmid (the ID line; only then may a feature cross the origin). Left empty, the record's own topology is used. Values: (From the record), circular (Circular), linear (Linear). Advance |
| _subject | object | 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. |
| _files | array | 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. |
Fold a set of oligos and check them against each other: every oligo's hairpin, its self-dimer anywhere and its self-dimer at the 3' end, plus the cross-dimer with every other oligo in the set, at any position and at a 3' end. This is primer3's thal — the same engine the Tm columns elsewhere use — so a pool can be screened before it is ordered rather than explained after a gel. The 3'-end measure
| Parameter | Type | Required | Notes |
|---|---|---|---|
| oligos | array | yes | the oligos to screen, 5'→3'. One is a valid pool: it still gets its hairpin and self-dimer. Wire the primers out of a design run, or list them. |
| names | array | no | optional labels, in the same order as oligos — what the pair table calls each one. Missing or short, the rest are numbered. Advanced. |
| mv_conc | number | no | monovalent cations (Na⁺ + K⁺ + Tris⁺), mM. In mM. |
| dv_conc | number | no | divalent cations (Mg²⁺), mM. In mM. |
| dntp_conc | number | no | total dNTPs, mM — subtracted from the divalent term, because dNTPs chelate Mg²⁺. In mM. |
| dna_conc | number | no | oligo strand concentration, nM — it moves a DIMER's Tm and leaves a hairpin's alone, because a hairpin is unimolecular. In nM. |
| temperature | number | no | the temperature ΔG is evaluated at. It does NOT move any Tm — Tm is the structure's own melting point — so change it to read ΔG at your annealing temperature. In °C. Advanced. |
| max_loop | number | no | largest internal loop the alignment will span (primer3's MAX_LOOP). Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Measure a sequence against what a NAMED synthesis vendor publishes it can make: length, average and windowed GC, homopolymer runs, tandem repeats, long repeats and hairpin-forming inverted repeats. Every threshold is the vendor's own, read from the vendor's own page with the date it was read, and every finding carries the span it is about so it can be drawn. It reports the limits that are MET as w
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vendor | string | no | which vendor product to measure against. Each carries its own limits, and two vendors can honestly disagree about one sequence. Values: idt-gblocks (IDT gBlocks Gene Fragments), idt-eblocks (IDT eBloc |
| sequence | string | no | the sequence to measure. Leave unset to use the open record, or the current selection when there is one. |
| feature | string | no | measure a named feature of the open record instead of the whole thing — the insert you are about to order rather than the vector it sits in. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Write the sheet IDT's gene-fragment PLATE upload takes for one or more designed fragments: one worksheet per 96-well plate, wells in the template's own order, and the template's four columns (well, name, sequence, 5' phosphorylation). A fragment outside the product's length range, unnamed, or carrying a non-IUPAC base is refused by name; one outside the product's published GC or homopolymer limits
| Parameter | Type | Required | Notes |
|---|---|---|---|
| product | string | no | which IDT fragment product to order the fragments as. It sets the length range a fragment must fall in, and eBlocks take a per-plate minimum. Values: idt-gblocks (gBlocks Gene Fragments (125–3,000 bp) |
| sequences | array | no | the fragments to order, 5'→3'. Leave unset to order the open record, or the current selection or named feature of it, under the record's name. |
| names | array | no | a name per fragment, in the same order. Required with sequences: a well is ordered by name, so an unnamed fragment is refused rather than numbered. |
| feature | string | no | order a named feature of the open record instead of the whole record: the insert rather than the vector it sits in. Advanced. |
| phosphorylate | boolean | no | ask for 5' phosphorylation on every fragment. IDT offers it for blunt cloning only. |
| plate_name | string | no | the plate's name, which becomes the worksheet's name. Several plates get ' (2)', ' (3)' appended. |
| _subject | object | 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. |
| _files | array | 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. |
Which Golden Braid / MoClo / Yeast ToolKit grammar, position and level the open plasmid represents (or null). Reads the record's own annotations, which is what lets an assembled transcription unit be recognised by its backbone half, and what lets a Level-0 module whose own backbone carries an extra site for the release enzyme be told from that backbone. Configured entry vectors are a Parts Bin con
| Parameter | Type | Required | Notes |
|---|---|---|---|
| _subject | object | 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. |
| _files | array | 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. |
Pairwise-align ONE sequencing read against a reference and hand on the two gapped rows, so the read can be graded. Needleman-Wunsch with free end gaps and the IUPAC substitution matrix — SeqTrace's aligner, the same call the trace editor makes, so a pipeline and the panel align a read identically. Leave reference unset to align against the record this step runs on.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| read | string | yes | the read's bases — wire a trace reader's sequence output here, or paste them. |
| reference | string | no | what to align against. Unset, it is the record this step runs on (the open plasmid, or an upstream product wired into the subject). |
| _subject | object | 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. |
| _files | array | 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. |
Trim sequencing adapters and low-quality ends off FASTQ reads before mapping, and report what was removed. This is cutadapt's algorithm: quality trimming is BWA's running-sum rule (not a threshold - a single bad base in a good tail is absorbed, a real decline is not), and the adapter is found by semiglobal alignment allowing errors, so a PARTIAL adapter at the very end of a read is caught where a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reads | string | yes | the reads to trim, as FASTQ - quality lines are required, because both halves of this need them. |
| adapter | string | no | the adapter sequence to remove. Unset means quality trimming only. Illumina TruSeq is AGATCGGAAGAGCACACGTCTGAACTCCAGTCAC and Nextera is CTGTCTCTTATACACATCT. |
| adapter_kind | string | no | which end the adapter sits at. A read running off the end of its insert hits the 3' adapter, which is why that is the default. |
| quality_cutoff_back | number | no | quality cutoff for the 3' end, where quality decays with cycle number. 0 is off; 20 is the usual choice. NOT a threshold on individual bases - see the description. |
| quality_cutoff_front | number | no | quality cutoff for the 5' end, which fails for different reasons than the 3' end and so takes its own number. 0 is off, and off is the usual answer. Advanced. |
| max_error_rate | number | no | errors allowed in the adapter match, as a fraction of the overlap. cutadapt's own default. Advanced. |
| min_overlap | number | no | an adapter overlap shorter than this is ignored. Low values trim real bases by chance - at 1, a read ending in the adapter's first base is 'trimmed'. Advanced. |
| min_length | number | no | reads shorter than this after trimming are COUNTED as too short, not removed - this tool does not filter. 0 reports none. Advanced. |
| phred_offset | number | no | quality encoding: 33 for every modern FASTQ, 64 only for pre-1.8 Illumina. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
FastQC's report on FASTQ reads, every module a default FastQC run reports: per-base quality boxes, per-tile quality (when the headers carry a tile), per-sequence quality, per-base sequence content, per-sequence GC against FastQC's theoretical normal, per-base N content, sequence length distribution, duplication levels, overrepresented sequences with their possible source, and adapter content, each
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reads | string | yes | the reads, as FASTQ: four lines per record, quality line required. |
| grouping | string | no | how read positions pool into one group: FastQC's default (the first 9 bases one by one, then groups sized to stay under 75), none (one per base, --nogroup) or exponential (--expgroup). |
| phred_offset | number | no | quality encoding: 33 for every modern FASTQ, 64 only for pre-1.8 Illumina (FastQC's --phred64). Advanced. |
| adapters | string | no | adapters to search for, in FastQC's --adapters format (a name, a tab, a sequence, one per line). Unset searches FastQC's own list. Advanced. |
| contaminants | string | no | sequences an overrepresented read is matched against for its possible source, in FastQC's --contaminants format (a name, a tab, a sequence, one per line). Unset uses FastQC's own list. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Map sequencing reads (FASTQ or FASTA) or assembled contigs onto a reference and return the alignment as SAM, the file a pileup viewer, a variant caller or samtools reads next. This is minimap2 (minimizer seeds, chaining, banded dual-affine extension with inversion detection, MAPQ), ported and checked record for record against the minimap2 2.31 CLI under every preset it offers: Illumina short r
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reads | string | yes | the reads: FASTQ (quality kept in the SAM) or FASTA (QUAL written as *). |
| mates | string | no | mate-2 reads, pairing record for record with reads. Empty maps the reads single-end. |
| reference | string | no | what to map against: bases, or a FASTA with one or more records. Unset, it is the record this step runs on. |
| preset | string | no | what is being mapped (-x): it sets every option below to minimap2's values for that data. The defaults shown are the short-read preset's; an option left unset takes the chosen preset's own value. Va |
| homopolymer_compressed | boolean | no | seed on homopolymer-compressed sequence (-H), so runs of one base count once: the PacBio CLR preset's answer to its length errors in homopolymers. Advanced. |
| k | number | no | k-mer size of the minimizer seeds (-k). Advanced. |
| w | number | no | minimizer window (-w): one seed kept per this many consecutive k-mers. Advanced. |
| max_seed_occurrence | number | no | seeds occurring more often than this in the reference are skipped (-f); the query length they cover is what rep_len reports, and it lowers MAPQ. Advanced. |
| min_minimizers | number | no | fewest seeds a chain may have (-n). Advanced. |
| bandwidth | number | no | band of the chaining and alignment dynamic programming (-r, first value): the most the two sequences may drift against each other inside one chain. In bp. Advanced. |
| bandwidth_long | number | no | wider band for the long join (-r, second value): when the best chain leaves much of a long read unexplained, its seeds are re-chained in this band. No effect under the short-read preset. In bp. Adva |
| max_gap | number | no | a chain stops at a gap longer than this between seeds (-g). In bp. Advanced. |
| min_chain_score | number | no | lowest chaining score kept (-m), roughly the number of matching bases the seeds cover. |
| match_score | number | no | score per matching base (-A). Advanced. |
| mismatch_penalty | number | no | penalty per mismatch (-B). Advanced. |
| transition_penalty | number | no | penalty for a transition (A↔G, C↔T) mismatch (-b); 0 scores it as any mismatch. Illumina Complete Long Reads use 4. Advanced. |
| gap_open | number | no | gap-open penalty of the short-gap cost (-O, first value). Advanced. |
| gap_open_long | number | no | gap-open penalty of the long-gap cost (-O, second value); a gap costs the cheaper of the two. Advanced. |
| gap_extend | number | no | per-base extension of the short-gap cost (-E, first value). Advanced. |
| gap_extend_long | number | no | per-base extension of the long-gap cost (-E, second value). Advanced. |
Grade a sequencing read against a reference (✓ verified / ⚠ near / ~ partial / ✗ divergent) from an alignment.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| aligned_read | string | yes | gapped read (query) row. |
| aligned_ref | string | yes | gapped reference (target) row. |
| target_name | string | no | what to call the reference in the report row. |
| read_name | string | no | what to call the read in the report row. |
| target_len | number | yes | reference length in bp. In bp. |
| verified_ungapped_pct | number | no | ungapped identity required to grade a read verified — NOT the gap-inclusive identity output. In %. |
| verified_coverage_pct | number | no | reference coverage required to grade a read verified. In %. |
| verified_max_gaps | number | no | gaps tolerated in a verified alignment. |
| near_ungapped_pct | number | no | ungapped identity required to grade a read near — NOT the gap-inclusive identity output. In %. |
| near_coverage_pct | number | no | reference coverage required to grade a read near. In %. |
| _subject | object | 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. |
| _files | array | 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. |
Read the QC files a sequencing provider returns alongside the reads: a per-base COVERAGE table, or a Plasmidsaurus summary (k-mer composition and the contamination estimate with its named source). These are the numbers that say whether a disappointing read is the clone's fault or the run's — a base called wrong under 3x coverage is a sequencing problem, not a cloning one. For a coverage table it a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | the file's contents — a per-base coverage TSV (pos / ref / reads_all), or the provider's summary text. |
| kind | string | no | which report this is; auto sniffs it. Values: auto (Detect from the contents), perbase (Per-base coverage table), plasmidsaurus (Plasmidsaurus summary). |
| coverage_line | number | no | the depth a position must reach to count as well covered. The default is the provider's own published line and nothing of ours; raise it for a construct you intend to publish. |
| step_window | number | no | positions either side of a boundary whose MEDIAN depth is compared, when looking for a sudden change in level. A median over a window rather than two adjacent positions, so one spike is not a step and |
| _subject | object | 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. |
| _files | array | 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. |
Silently recode the internal Type-IIS sites inside a part's coding sequence so the part can be used in a Golden Gate assembly — same protein, no recognition site. Only occurrences the given CDS covers can be fixed this way; any outside it are reported untouched rather than skipped quietly, because a site in a promoter needs a different answer.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the part to domesticate — wire a record, name a library document, or leave unset to use the open record. |
| enzyme | string | no | the Type-IIS enzyme whose sites must go. |
| cds_start | number | yes | 0-based start of the coding sequence within the part. |
| cds_end | number | yes | 0-based end of the coding sequence (exclusive). |
| cds_strand | number | no | 1 for the top strand, -1 for the bottom. Values: 1 (Top strand), -1 (Bottom strand). |
| table | string | no | the codon-usage table to guide the synonymous choice, BY NAME, as the Codon Usage panel lists it. This is the way to pass a table: it resolves against the tables loaded in this project, so the numbers |
| table_tsv | string | no | ONLY for a table you are pasting yourself, measured elsewhere — prefer table, which names one this project already has. Do NOT write a table out from memory: codon frequencies are measured data, and |
| _subject | object | 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. |
| _files | array | 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. |
Design the PCR primers that ADD Type-IIS fusion sites to a part: enzyme site, spacer and the four-base overhang you chose, on a Tm-matched annealing footprint. This is how a sequence that is not yet a Golden Gate part becomes one, and it is the other half of check_golden_gate_parts — that says which parts are unusable, this makes one usable.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the template to amplify — wire a record, name a library document, or leave unset to use the open record. |
| enzyme | string | no | the Type-IIS enzyme the assembly will use. |
| left_overhang | string | yes | the top-strand overhang to leave at the START of the released part — its length must match the enzyme's own overhang. |
| right_overhang | string | yes | the top-strand overhang to leave at the END of the released part. |
| target_tm | number | no | target annealing temperature for the template-binding footprint. In °C. |
| buffer_bases | string | no | 5' buffer bases outside the recognition site, so the enzyme has somewhere to sit (NEB recommends 6 nt). Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Extract @plasmid / !action / &gel cross-references from a lab-notebook markdown body.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| body_md | string | yes | the notebook entry body (markdown). |
| _subject | object | 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. |
| _files | array | 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. |
Render a construct's build history into a numbered bench-recipe protocol.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| root | object | yes | a history-node tree. |
| _subject | object | 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. |
| _files | array | 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. |
Propose the minimal SILENT synonymous edits that remove forbidden restriction sites from a CDS (a design/write).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| dna | string | yes | the CDS nucleotide sequence (in frame). |
| protein | string | yes | the CDS translation (for silence checking). |
| table | string | no | the codon-usage table to guide synonym choice, BY NAME, as the Codon Usage panel lists it. This is the way to pass a table: it resolves against the tables loaded in this project, so the numbers come f |
| table_tsv | string | no | ONLY for a table you are pasting yourself, measured elsewhere — prefer table, which names one this project already has. Do NOT write a table out from memory: codon frequencies are measured data, and |
| _subject | object | 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. |
| _files | array | 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. |
Minimum-free-energy secondary structure (dot-bracket + ΔG) of an RNA/DNA sequence (Turner-2004).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| seq | string | yes | the RNA/DNA sequence (T read as U). |
| _subject | object | 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. |
| _files | array | 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. |
Amplify the subject template with a forward + reverse primer (pydna Anneal). Emits the first product as a NEW sequence record so downstream tools (digest, gel, map) operate on the amplicon, not the template — the tool→tool hand-off.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| forward | string | yes | forward primer 5'→3'. |
| reverse | string | yes | reverse primer 5'→3'. |
| limit | number | no | min 3' footprint match length (pydna limit). In bp. Advanced. |
| mismatches | number | no | substitutions a primer may carry and still prime (QUEEN {s<=N}). 0 is pydna's exact search, which is what the panel opens on and what every golden was captured under. Advanced. |
| end_length | number | no | 3'-most bases that must pair exactly whatever the mismatch budget (QUEEN endlength) — a polymerase extends from a paired 3' terminus, so this is not negotiable by the budget. Advanced. |
| dimer_threshold | number | no | the dimer-free cut-off primerDimerScore is judged against (PCR-35). The default is the value PrimerROC publishes, which that paper fitted on its own gels and says is specific to its PCR conditions — |
| nn_table | string | no | nearest-neighbour table the Tm and Ta are computed on. Left unset it is the panel's own default, SantaLucia & Hicks 2004 unified. Values: DNA_NN1 (Breslauer 1986), DNA_NN2 (Sugimoto 1996), DNA_NN3 (Al |
| dmso | number | no | DMSO in the reaction, % (v/v) — depresses every primer Tm and therefore the annealing temperature. In %. Advanced. |
| dmso_model | string | no | which published DMSO depression to apply; they disagree by 2 °C at 8% DMSO, so a Tm quoted without naming one is not reproducible. Values: ahs01 (Ahsen et al. (2001)), mus81 (Musielski et al. (1981)), |
| conditions | object | no | the reaction buffer every temperature here is computed in - Na+/K+/Tris/Mg2+/dNTPs, the primer concentration, the salt-correction method and the melting model. Left unset it is filled from your reacti |
| inner_forward | string | no | nested PCR: the inner forward primer 5'→3'. With inner_reverse, forward/reverse are the outer pair and every output below describes ROUND 2. Advanced. |
| inner_reverse | string | no | nested PCR: the inner reverse primer 5'→3'. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Design site-directed mutagenesis (SOE-PCR/QuikChange) primers for a point change on a CDS: the ranked inner mutagenic pairs, the constant outer pair, and the single spanning primer that replaces an outer when the site sits too near a CDS end. A design/write.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| cds | string | yes | the CDS nucleotide sequence, in frame from the start codon. |
| mutation | string | yes | the change as [WT][pos][MUT], e.g. "W140F" (1-based residue). |
| tm_model | string | no | Tm scale the candidates are scored and ranked on. The 55-75 °C window is calibrated for SantaLucia NN; wallace is upstream's primer3-free fallback, kept for golden parity. Values: santalucia (SantaL |
| codon_usage_tsv | string | no | codon-usage table the mutant codon is drawn from, as a Kazusa-style TSV. Left empty it is the built-in E. coli K12 table, which is what the panel's codon picker opens on. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Design site-saturation mutagenesis (SSM) primers: one overlapping forward/reverse pair per site, each carrying a degenerate codon, sharing ONE reaction-level overlap and 3' temperature so every site amplifies in the same tube (both of Mutation Maker's solvers: fast approximation by default, exhaustive search on request). Every Tm is Biopython's Tm_NN over the Allawi & SantaLucia 1997 nearest-nei
| Parameter | Type | Required | Notes |
|---|---|---|---|
| cds | string | yes | the CDS nucleotide sequence, in frame from the start codon (length must be a multiple of 3). |
| sites | string | yes | the saturation sites, comma- or space-separated, as [WT][pos]X — e.g. "V2X, K107X". 1-based residue positions. |
| degenerate_codon | string | no | the degenerate codon installed at every site (NNK is the common 32-codon choice). |
| solver | string | no | which of Mutation Maker's two solvers designs the pairs. fast grows one candidate per site per temperature combination (upstream's own default, milliseconds). exhaustive enumerates every primer of |
| forward_primer | string | no | 5' flanking primer, 5'→3'. Left empty, it is read off the open plasmid 56 bp either side of the CDS (22 nt, and only when it occurs there exactly once). |
| reverse_primer | string | no | 3' flanking primer, 5'→3' on its own strand. Left empty, it is read off the open plasmid 56 bp either side of the CDS (22 nt, and only when it occurs there exactly once). |
| five_end_flank | string | no | explicit 5' flanking sequence — only for a free-standing gene with no plasmid open, and then the 3' flank is required too. Advanced. |
| three_end_flank | string | no | explicit 3' flanking sequence, the partner of five_end_flank. Advanced. |
| min_overlap_temperature | number | no | lowest overlap Tm the reaction may settle on. In °C. |
| max_overlap_temperature | number | no | highest overlap Tm allowed. In °C. |
| min_three_end_temperature | number | no | lowest 3'-end Tm (used when exclude_flanking_primers is on; otherwise the window comes from the flanking pair). In °C. Only applies when exclude_flanking_primers is true. |
| max_three_end_temperature | number | no | highest 3'-end Tm allowed. In °C. |
| three_end_temp_range | number | no | width of the 3'-end Tm window scanned around each candidate temperature. In °C. Advanced. |
| overlap_temp_range | number | no | width of the overlap Tm window. In °C. Advanced. |
| three_end_temp_range_step | number | no | step between 3'-end temperatures tried. In °C. Advanced. |
| overlap_temp_range_step | number | no | step between overlap temperatures tried. In °C. Advanced. |
| separate_forward_reverse_temperatures | boolean | no | optimise the forward and reverse 3' temperatures independently. Advanced. |
| exclude_flanking_primers | boolean | no | take the 3' Tm window from the explicit min/max above instead of from the flanking pair's own Tm. Advanced. |
| min_primer_size | number | no | shortest whole primer. In nt. Advanced. |
| max_primer_size | number | no | longest whole primer. In nt. Advanced. |
Design QCLM (quick-change lightning multi-site) oligos: one primer per mutated site, all annealing in one reaction, with the codons drawn from an organism's usage table. A design/write.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| cds | string | yes | the CDS nucleotide sequence, in frame from the start codon. |
| mutations | string | yes | the substitutions, comma- or space-separated, as [WT][pos][MUT] — e.g. "E42L, E42W, K107M". Several entries at one position are ONE site delivering several aminos. |
| seed | number | no | seed for the codon draw. The same seed and the same request give the same oligos; change it to re-roll. |
| organism | string | no | codon-usage table the synonymous choice is drawn from. |
| five_end_flank | string | no | explicit 5' context. Left empty, 60 bp is read off the open record either side of the CDS. Advanced. |
| three_end_flank | string | no | explicit 3' context, the partner of five_end_flank. Advanced. |
| min_temperature | number | no | lowest Tm threshold the growth scan sweeps. In °C. |
| max_temperature | number | no | highest Tm threshold swept. In °C. |
| temp_range_size | number | no | width of the acceptable Tm window around the reaction temperature. In °C. Advanced. |
| temp_threshold_step | number | no | step between Tm thresholds tried. In °C. Advanced. |
| min_primer_size | number | no | shortest oligo. In nt. Advanced. |
| max_primer_size | number | no | longest oligo. In nt. Advanced. |
| min_three_end_size | number | no | bases between the last mutated codon and the 3' terminus, minimum. In nt. Advanced. |
| max_three_end_size | number | no | longest 3' tail. In nt. Advanced. |
| min_five_end_size | number | no | bases between the 5' terminus and the first mutated codon, minimum. In nt. Advanced. |
| max_five_end_size | number | no | longest 5' lead. In nt. Advanced. |
| min_gc_content | number | no | lowest oligo GC accepted. In %. Advanced. |
| max_gc_content | number | no | highest GC accepted. In %. Advanced. |
| use_degeneracy_codon | boolean | no | collapse a site's codons into one IUPAC-degenerate codon (upstream's default). Off, each amino gets its own oligo. |
| codon_usage_frequency_threshold | number | no | discard synonymous codons rarer than this fraction in the chosen organism. |
Reverse-complement the subject sequence. Emits a NEW record, so downstream nodes (map, digest, gel, ORF) run on the revcomp rather than the original.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| _subject | object | 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. |
| _files | array | 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. |
Translate the subject DNA to protein (Biopython Bio.Seq.translate semantics). The SUBJECT is the selection when there is one, the named feature when feature is given, and the whole record otherwise — the region output says which, so never paste bases in to scope it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| table | number | no | NCBI genetic-code table id (1 = standard). |
| to_stop | boolean | no | stop at the first stop codon instead of emitting the stop symbol. |
| cds | boolean | no | strict CDS: require a length multiple of 3, a start codon and a terminal stop (errors otherwise). Advanced. |
| feature | string | no | translate this annotated coding feature by NAME instead of the selection (e.g. "ADH1"). A name the record does not annotate is refused with the names it does. |
| reverse | boolean | no | read the region as the reverse complement. Stated explicitly this always wins; left out, the selection's or the feature's own strand decides. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Find open reading frames on BOTH strands of the subject (origin-spanning when circular).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| min_size | number | no | minimum ORF size. In bp. |
| alternative_starts | boolean | no | also accept GTG/CTG as start codons (not just ATG). |
| _subject | object | 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. |
| _files | array | 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. |
Digest the subject with the given enzymes into real fragments (sequence + both overhangs). Emits the selected fragment as a NEW record, so a downstream gel/map/ORF runs on that fragment — the digest→assembly hand-off.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| enzymes | array | yes | enzymes to digest with — resolved against the bundled cut catalog (REBASE spellings; smaller than the REBASE dossier the editor shows). Left unset, the run uses your active enzyme collection. |
| fragment_index | number | no | which fragment to emit as the downstream record (0-based, in cut order). |
| _subject | object | 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. |
| _files | array | 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. |
GC fraction of the subject — whole-sequence, or a sliding window profile (DnaChisel).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| window | number | no | sliding-window size; unset = one value for the whole sequence. In bp. |
| _subject | object | 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. |
| _files | array | 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. |
What the subject record is MADE OF: molecular weight under its own topology and strand count, GC and AT over the resolved bases, and the per-symbol census with the ambiguity codes broken out. The nucleic-acid counterpart of protein_properties, and the same derivation the editor's Properties panel, its inspector and the alignment inspector all draw (Biopython's mass model; ProtParam for a protein
| Parameter | Type | Required | Notes |
|---|---|---|---|
| doubleStranded | boolean | no | weigh BOTH strands (a plasmid or any dsDNA record) rather than the one strand written in the file (an oligo, an RNA, an alignment row). The two answers differ by about a factor of two, which is why it |
| _subject | object | 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. |
| _files | array | 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. |
Molecular weight (average + monoisotopic), molecular formula, isoelectric point, instability index and amphipathicity (Boman index, Eisenberg hydrophobic moment) of a protein sequence (Biopython ProtParam + peptides + pyteomics).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. |
| momentWindow | number | no | sliding window for the hydrophobic moment, in residues (default 11; clamped to the sequence length). |
| cystineConvention | string | no | how the oxidised e280 counts cysteines: 'cystine' = 125 per disulfide (ProtParam, default) or 'perCysteine' = 62.5 per residue (SnapGene). They differ only on an ODD cysteine count. |
| gravyScale | string | no | hydropathy scale GRAVY is averaged over (all 28 ProtParam/ProtScale scales; default Kyte & Doolittle). Values: KyteDoolitle (Kyte & Doolittle (1982)), Aboderin (Aboderin (Int J Biochem 2:537)), Abraha |
| pH | number | no | pH the net charge is reported at (default 7.0). |
| _subject | object | 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. |
| _files | array | 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. |
Windowed physicochemical profile along a protein (ExPASy ProtScale). Pass scaleId for any of the 57 scales ProtScale publishes plus the 14 Biopython tables it does not, with optional 0-1 normalisation; or pass kind for the five ProtParam profiles (hydropathy over the 28 GRAVY scales, Vihinen flexibility, Hopp & Woods hydrophilicity, Emini surface accessibility, Janin interior-to-surface transf
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. |
| kind | string | no | which profile to compute. Ignore this and pass scaleId to reach the full ProtScale catalogue. |
| scale | string | no | hydropathy scale. Values: KyteDoolitle (Kyte & Doolittle (1982)), Aboderin (Aboderin (Int J Biochem 2:537)), AbrahamLeo (Abraham & Leo (1987)), Argos (Argos (Eur J Biochem 128:565)), BlackMould (Black |
| scaleId | string | no | any of the 57 ExPASy ProtScale scales, or the 14 Biopython tables ProtScale does not publish. Pass this INSTEAD of kind and scale, never alongside them: sending scaleId together with kind is r |
| normalize | boolean | no | ProtScale's 'normalize the scale from 0 to 1' — rescales the twenty scale values before windowing, so profiles from different scales are comparable. Requires scaleId. |
| window | number | no | ProtScale window in residues, odd (default 9). IGNORED for 'flexibility', whose Vihinen parameters are only defined at 9. Only applies when kind is hydropathy or hydrophilicity or accessibility or int |
| edge | number | no | ProtScale relative weight of the window's edge residues, 0-1 (default 1 = unweighted). |
| weightVariation | string | no | ProtScale's weight model between the centre and the edge weight: 'linear' steps down evenly, 'exponential' decays steeply near the centre. Requires scaleId; identical at edge 1. |
| _subject | object | 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. |
| _files | array | 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. |
Signal-peptidase cleavage sites in a protein, by von Heijne's (1986) weight matrix as implemented by EMBOSS sigcleave. Scores a 15-residue window at every position (the 13 residues before the cut plus the first two after) against either the eukaryotic or the prokaryotic training set. Predicts WHERE the cut would fall, not WHETHER the protein is secreted — a high score away from the N-terminus is a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. |
| kingdom | string | no | which of von Heijne's training sets to score against: 161 aligned eukaryotic or 36 prokaryotic signal peptides. Pick the one matching the EXPRESSION HOST — the two disagree by several points on the sa |
| minWeight | number | no | report sites scoring strictly above this. EMBOSS's default of 3.5 finds ~95% of real signal peptides and rejects ~95% of non-signal sequences. |
| _subject | object | 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. |
| _files | array | 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. |
Eisenberg hydrophobic-moment plot along a protein: per-window mean hydrophobicity and moment, each classified Globular / Transmembrane / Surface-seeking, plus those windows collapsed into residue spans. A hydrophobicity-based prediction, NOT a trained topology model.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. |
| window | number | no | sliding window in residues (default 11). |
| angle | number | no | rotational angle per residue in degrees: 100 for an alpha-helix (default), 160 for a beta-sheet. |
| minWindows | number | no | shortest run of same-class windows reported as a segment (default 2; a one-window run is usually noise). |
| _subject | object | 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. |
| _files | array | 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. |
Transmembrane topology of a protein by the HMM-TM 114-state hidden Markov model (JUCHMME, Bagos et al.), decoded residue by residue into inside / transmembrane-helix / outside runs. Reports the labelled path, the runs as residue spans, and the per-residue posterior. Needs the trained model, which the host loads once per session — this refuses by name when it has not been.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. |
| decoding | string | no | which decoder: 'viterbi' the single most probable state path (default, and the fast one); 'posterior-viterbi' and 'optimal-accuracy' re-decode over the posterior; 'n-best' beams over label SEQUENCES r |
| _subject | object | 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. |
| _files | array | 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. |
Intrinsic disorder along a protein by FoldIndex (Prilusky 2005): I_F = 2.785·⟨H⟩ − |⟨R⟩| − 1.151 over a sliding window, where ⟨H⟩ is mean normalized Kyte-Doolittle hydropathy and ⟨R⟩ the mean net charge per residue. Negative means predicted unfolded. Reports the whole-protein score, the per-window series, the runs below zero, and the Uversky charge-hydropathy point with the boundary it was judged
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. |
| window | number | no | sliding window in residues, odd so a window has a centre residue to report at (default 51, the size the FoldIndex paper uses). Short windows expose single loops; long ones report whole domains. |
| chargeModel | string | no | 'net' counts whole charges K+R−D−E, which is what the paper does; 'henderson-hasselbalch' uses fractional charges at pH. They answer different questions and only the first is settled by the paper. |
| pH | number | no | pH for the Henderson-Hasselbalch model, ignored by 'net' (default 7.0, the pH the paper's ⟨R⟩ is defined at). Only applies when chargeModel is henderson-hasselbalch. |
| pKaSet | string | no | named pKa set for the Henderson-Hasselbalch model (default IPC_protein, which is idpr's). Values: EMBOSS (EMBOSS (Rice 2000)), DTASelect (DTASelect (Tabb 2002)), Solomons (Solomons (Solomons 1992)), S |
| countHistidine | boolean | no | count histidine as positive in the 'net' model. False by default: the paper says charged residues at pH 7.0, and His (pKa ~6) is ~9% protonated there, so Uversky's set is K,R vs D,E — exposed because |
| _subject | object | 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. |
| _files | array | 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. |
Per-residue intrinsic disorder by metapredict (Emenecker, Griffith & Holehouse, Biophys J 2021; V2/V3 the lab's successors), a bidirectional LSTM trained to reproduce a consensus of disorder predictors, run locally. Reports a 0–1 score per residue, the IDRs and folded domains its domain caller draws from the smoothed profile, and the percentage of residues at or above the network's threshold. A di
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence; wire it from translate_sequence. |
| version | string | no | which trained network: V3 (the package default), V2, or V1 (the published 2021 network). Values: V3 (V3 (default)), V2 (V2), V1 (V1 (published, legacy)). |
| threshold | number | no | smoothed score above which a residue can seed an IDR, and per-residue score at or above which it counts as disordered. Omit for the network's own: V1 0.42, V2 and V3 0.5. |
| minimumIdrSize | number | no | the shortest IDR the domain caller reports, in residues; also sets the smoothing window (twice this, made odd). Default 12. Advanced. |
| minimumFoldedDomain | number | no | gaps between IDRs shorter than this are re-tested at 0.75× the threshold, so short ordered stretches inside an IDR are absorbed. Default 50. Advanced. |
| gapClosure | number | no | the longest run of sub-threshold residues closed when flanked by disordered runs of the same length. Default 10. Advanced. |
| convert | boolean | no | read B as N, U as C, X as G and Z as Q, as metapredict's FASTA readers do; off refuses them. Default true. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
In-silico proteolytic digest of a protein (ExPASy PeptideCutter / PeptideMass): peptides with coordinates, average and monoisotopic masses, m/z per charge state, and the MS mass-window filter. 49 proteases and chemicals — or an enzyme of your own written in RPG rule grammar — one or several at a time; a multi-enzyme digest runs concurrently (all at once, products re-digested until nothing changes)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. |
| enzyme | string | no | protease or chemical (single-enzyme digest), or 'custom' to use customCleave. Values: arg-c (Arg-C proteinase), asp-n (Asp-N endopeptidase), asp-n-sg (Asp-N, sequencing grade (D and C)), bnps-skatol |
| enzymes | array | no | two or more proteases for a multi-enzyme digest; overrides enzyme. Order matters in concurrent mode. 'custom' takes its place in the order like any other. |
| customCleave | array | no | cleaving rules for the 'custom' enzyme, in RPG grammar: the comma is the cut, so '(,A)' cleaves before A and '(K or R,)' after K or R. Empty parentheses mean any residue. |
| customExceptions | array | no | exceptions for the 'custom' enzyme; each must repeat the rule it blocks, e.g. '(K or R,)(P)' = not when P follows. |
| customRegex | string | no | the 'custom' enzyme as a regular expression instead of RPG grammar (pyteomics' rule=): it matches at P1 and the cut falls after the match, e.g. '[KR]' cleaves after K or R. Single-enzyme only, and m |
| mode | string | no | multi-enzyme only. 'concurrent' = all at once, re-digesting products until nothing changes (can cut where no single enzyme cuts the intact chain); 'sequential' = one result per enzyme, each on the int |
| missedCleavages | number | no | single enzyme: allow up to this many internal sites per peptide (pyteomics). Multi-enzyme: append runs of up to this many merged adjacent peptides (RPG). |
| keilExceptions | boolean | no | apply Keil's exception rules (sites trypsin does NOT cut despite matching). Only defined for trypsin. PeptideCutter and Bioconductor cleaver apply these by default, which is why this does too; pyteomi |
| semi | boolean | no | also emit semi-enzymatic peptides (one ragged terminus). |
| minLength | number | no | drop peptides shorter than this (residues). |
| maxLength | number | no | drop peptides longer than this (residues). |
| massMin | number | no | keep only peptides at or above this monoisotopic mass [Da]; omit for no lower bound. |
| massMax | number | no | keep only peptides at or below this monoisotopic mass [Da]; omit for no upper bound. |
| charges | array | no | charge states to report m/z for, e.g. [1,2,3] — [M+zH]z+ from the monoisotopic mass. |
| cysteine | string | no | cysteine alkylation applied before the digest, as ExPASy PeptideMass offers it. Mass deltas are Unimod's. |
| metOxidation | string | no | methionine oxidation. 'all' oxidises every Met (masses move, peptide list unchanged); 'both' lists each Met peptide TWICE, unmodified and oxidised, as PeptideMass does. |
| _subject | object | 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. |
| _files | array | 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. |
Monoisotopic and average mass of a peptide, and its m/z at each charge state (validated against pyteomics). Plain one-letter sequences also take an ion type (b, y, c, z, a, x and their neutral-loss forms); a ProForma peptidoform with modification tags, as masses or Unimod names and accessions (e.g. [TMT6plex]-PEPTM[Oxidation]IDE, M[UNIMOD:35], M[+15.994915]), is weighed monoisotopically with its m
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | yes | peptide: one-letter residues, optionally ProForma tags on residues and termini (a signed mass, a Unimod name, or UNIMOD:accession). |
| ionType | string | no | weigh the peptide as this ion; M is the intact molecule. Plain sequences only. |
| charges | array | no | charge states to report m/z for (positive integers). |
| _subject | object | 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. |
| _files | array | 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. |
Theoretical MS/MS fragment ion ladder of a peptide: a, b, c from the N-terminus and x, y, z from the C-terminus, with neutral-loss and radical variants, at each charge up to a maximum (validated against pyteomics, cross-checked against OpenMS). Takes ProForma modification tags (a signed mass, a Unimod name, or UNIMOD:accession) on residues and termini.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | yes | peptide: one-letter residues, optionally ProForma tags, e.g. [TMT6plex]-PEPTM[Oxidation]IDE or [+229.162932]-PEPTM[+15.994915]IDE. |
| ionTypes | array | no | ion series to generate. |
| maxCharge | number | no | highest fragment charge (every charge from 1 up to it). |
| _subject | object | 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. |
| _files | array | 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. |
The most probable isotopic composition of a peptide (e.g. how many 13C atoms it most likely carries) and that composition's relative abundance, from natural isotope abundances (validated against pyteomics).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | yes | peptide, plain one-letter residues. |
| _subject | object | 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. |
| _files | array | 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. |
Coarse isotope pattern of a peptide or of an elemental formula (C29H31N7O, as a compound's formula reads): the relative heights and masses of its M, M+1, M+2 … peaks as an instrument that does not resolve isotopic fine structure sees them, computed by per-element convolution from natural abundances (validated against OpenMS).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | peptide, plain one-letter residues; give this or formula. |
| formula | string | no | elemental formula of a neutral compound (C29H31N7O; isotopes as C[13]); give this or sequence. |
| maxIsotope | number | no | peaks to keep (M counts as one); 0 keeps every peak. |
| charge | number | no | protons added; masses then include them (divide by the charge for m/z). |
| _subject | object | 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. |
| _files | array | 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. |
Score how well an MS/MS spectrum matches a peptide with the X!Tandem HyperScore (validated against OpenMS): b and y ions are generated for the peptide, matched to the observed peaks within a tolerance, and scored as ln(1 + dot product) + ln(matched b!) + ln(matched y!).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| peptide | string | yes | candidate peptide, one-letter residues with optional ProForma tags (a signed mass, a Unimod name, or UNIMOD:accession). |
| mz | array | yes | observed peak m/z values. |
| intensity | array | yes | observed peak intensities, one per m/z. |
| precursorCharge | number | no | precursor charge; fragments are generated at charges 1 to max(1, charge - 1). |
| tolerance | number | no | fragment match tolerance. |
| toleranceUnit | string | no | unit of the tolerance. |
| _subject | object | 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. |
| _files | array | 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. |
Read the MS/MS spectra of a Mascot Generic Format (MGF) file: each spectrum's title, precursor m/z, precursor intensity, declared charge states and peak list, interpreted as pyteomics reads MGF (validated on every spectrum of PXD000001). A spectrum it returns is what score_spectrum takes as mz, intensity and precursorCharge.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | the MGF file's contents. |
| title | string | no | return only the spectrum with this title; empty returns every spectrum. |
| _subject | object | 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. |
| _files | array | 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. |
Read the spectra of a PSI mzML run file: each spectrum's native id, MS level, centroid or profile, scan start time and unit, base peak, total ion current, precursor (selected ion m/z, charge, intensity, isolation window) and peak arrays, interpreted as pyteomics reads mzML (validated on every spectrum of three real runs). An MS/MS spectrum it returns is what score_spectrum takes as mz, intensity a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | the mzML file's contents. |
| id | string | no | return only the spectrum with this native id; empty returns every spectrum. |
| msLevel | number | no | return only spectra at this MS level (0 returns every level). |
| _subject | object | 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. |
| _files | array | 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. |
Protein inference from peptide-spectrum matches (validated against OpenMS BasicProteinInferenceAlgorithm on PXD000001): maps each peptide to the protein database, keeps the best match per spectrum, scores each protein by aggregating its peptides' best scores, reports the proteins its evidence cannot tell apart as indistinguishable groups, and the percent of each sequence the matches cover.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| psms | string | yes | the matches as a table with a header row naming spectrum, peptide, charge and score (tab- or comma-separated); peptides are ProForma. |
| database | string | yes | the protein database searched, as FASTA; the accession is the header up to the first space. |
| scoreColumn | string | no | which column holds the score inference uses, when the table carries several (OpenMS score_type); a column named pep or q-value sets its own direction. |
| higherIsBetter | boolean | no | true for scores like HyperScore; false for e-values, q-values and PEPs. |
| scoresArePep | boolean | no | the scores are posterior error probabilities: matches compete lowest first, and each protein combines 1 − PEP into a posterior probability (higher is better); implies higherIsBetter false. |
| aggregation | string | no | how a protein's peptide scores combine: best one, mean (sum over count), or product. |
| chargeVariantsSeparate | boolean | no | count each charge state of a peptide as its own evidence. |
| modificationVariantsSeparate | boolean | no | count each modified form of a peptide as its own evidence. |
| useSharedPeptides | boolean | no | let a peptide that maps to several proteins count for each of them. |
| minPeptides | number | no | report only proteins with at least this many evidences (0 reports every matched protein). |
| greedyGroupResolution | boolean | no | razor peptides: give each shared peptide only to its best-scoring protein or group (ties to the one with more matches) and drop proteins left with no peptide of their own. |
| peptideProteinResolution | boolean | no | resolve shared peptides between indistinguishable groups: in each connected set of groups the highest-probability group (then the one with more peptides) takes its peptides from the rest, and each set |
| maxAmbiguousResidues | number | no | how many ambiguous database residues (B, J, Z, X) one peptide match may resolve. |
| ilEquivalent | boolean | no | treat isoleucine and leucine (and a database J) as the same residue when mapping peptides. |
| coverageOf | string | no | the accession whose sequence coverage is drawn; empty draws the first protein of the best group, as the Coverage tab opens on. |
| _subject | object | 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. |
| _files | array | 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. |
Bayesian protein inference, Epifany (validated against OpenMS BayesianProteinInferenceAlgorithm on PXD000001): the posterior probability that each protein, each indistinguishable group and each peptide-spectrum match is present, from the matches' posterior error probabilities under a network in which present proteins emit their peptides. Shared peptides are weighed between their proteins instead o
| Parameter | Type | Required | Notes |
|---|---|---|---|
| psms | string | yes | the matches as a table with a header row naming spectrum, peptide, charge and a posterior error probability column (tab- or comma-separated); peptides are ProForma. |
| database | string | yes | the protein database searched, as FASTA; the accession is the header up to the first space. |
| scoreColumn | string | no | the column holding each match's posterior error probability (PEP, 0 to 1). |
| alpha | number | no | peptide emission probability α: the chance a present protein yields a given one of its peptides. |
| beta | number | no | spurious emission probability β: the chance a peptide is reported with none of its proteins present. |
| gamma | number | no | protein prior γ: the chance a protein is present before any evidence. |
| peptidePrior | number | no | peptide prior π, dividing each match's probability back out of its evidence. |
| psmCutoff | number | no | drop matches whose probability (1 − PEP) is below this. |
| gridSearch | boolean | no | choose α, β and γ instead: run OpenMS's grid (α 0.1–0.8 × β 0.01–0.4 × γ 0.2–0.7) and keep the combination whose protein posteriors best agree with target-decoy FDR and separate targets from decoys; n |
| decoyPrefix | string | no | accession prefix marking a decoy protein, for the grid search. |
| appendReversedDecoys | boolean | no | add the reversed sequence of every database protein as a decoy (accession decoyPrefix + accession), for a database searched with reversed decoys that holds only targets. |
| maxAmbiguousResidues | number | no | how many ambiguous database residues (B, J, Z, X) one peptide match may resolve. |
| ilEquivalent | boolean | no | treat isoleucine and leucine (and a database J) as the same residue when mapping peptides. |
| _subject | object | 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. |
| _files | array | 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. |
False discovery rate and q-values for peptide-spectrum matches by target-decoy competition (validated against pyteomics): give each match's score and whether it hit a decoy; returns every match's q-value, the whole set's FDR, and how many targets pass a q-value threshold. Supports the +1 and finite-sample corrections of Levitsky et al. 2017.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| scores | array | yes | one score per match. |
| isDecoy | array | yes | one flag per match: true when it is a decoy hit. |
| higherIsBetter | boolean | no | true for scores like HyperScore; false for e-values and PEPs. |
| formula | number | no | 1: decoys / targets. 2: (decoys + estimated false targets) / all matches. |
| ratio | number | no | decoy-to-target database size ratio. |
| correction | number | no | 0 none; 1 the +1 correction; 2 finite-sample expectation; a value in (0, 1) is a confidence level. |
| threshold | number | no | q-value cut-off for the accepted count. |
| _subject | object | 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. |
| _files | array | 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. |
Design and score CRISPR guides on the subject — on/off-target scores, QC flags, and cloning-enzyme conflicts. Nuclease list comes from the real nuclease registry.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| nuclease | string | no | the nuclease (PAM + spacer length) to scan for. Values: SpCas9 (SpCas9: NGG (3')), SpCas9-NG (SpCas9-NG: NG (3')), SpG (SpG: NGN (3')), SpRY (SpRY: NRN (3')), xCas9 (xCas9: NG (3')), SaCas9 (SaCas9: N |
| region_start | number | no | restrict results to guides starting at/after this position (0-based). In bp. Advanced. |
| region_end | number | no | restrict results to guides ending at/before this position. In bp. Advanced. |
| restriction_enzymes | array | no | cloning enzymes whose recognition site must NOT appear in the spacer. Advanced. |
| min_stem | number | no | minimum self-complementary stem to report. In nt. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Turn the open record's annotated targets into an ORDERABLE sgRNA oligo pool: the best N guides per target, filtered at order time (Pol-III terminator, Graf inactive motif, cloning-enzyme site, minimum on-target score), each composed into the oligo a synthesiser makes — the vector's cloning overhangs around the spacer plus, optionally, one of CRISPOR's eleven subpool barcodes. A spacer that serves
| Parameter | Type | Required | Notes |
|---|---|---|---|
| nuclease | string | no | the nuclease (PAM + spacer length) to scan for. Values: SpCas9 (SpCas9: NGG (3')), SpCas9-NG (SpCas9-NG: NG (3')), SpG (SpG: NGN (3')), SpRY (SpRY: NRN (3')), xCas9 (xCas9: NG (3')), SaCas9 (SaCas9: N |
| target_type | string | no | annotation type to take as the targets, one pool entry per feature of that type (CDS, gene, …). Leave unset to treat the whole record as a single target — which is what a saturating-mutagenesis po |
| guides_per_target | number | no | how many guides to take per target, best-ranked first. |
| rank | string | no | which on-target score orders the candidates. A guide the chosen model cannot score is left unranked, never dropped. Rule Set 3 is deliberately not offered here: its weights are a 9.8 MB download the e |
| exclude_poly_t | boolean | no | drop guides whose spacer carries a Pol-III (TTTT) terminator. |
| exclude_graf | boolean | no | drop guides matching a Graf 2019 inactive motif (the TT/GCC classes). |
| restriction_enzymes | array | no | cloning enzymes whose recognition site must NOT appear in the spacer — a hit drops the guide from the pool. Advanced. |
| barcode_id | number | no | CRISPOR subpool barcode id, 0 for none — lets several sub-libraries share one synthesis array and amplify apart. Advanced. |
| custom_prefix | string | no | your vector's 5' cloning overhang. BOTH sides must be given, or the pool stays on pLentiGuide — that is upstream's rule, reproduced. Advanced. |
| custom_suffix | string | no | your vector's 3' cloning overhang. Advanced. |
| representation | number | no | cells you intend to keep carrying EACH guide. Joung et al. 2017 recommends >500; the default here is the neutral 1, not that recommendation, so the plan is the identity until you choose a scale. Advan |
| transduction_efficiency | number | no | fraction of cells that take up a construct, 0-1 — sizes the transduction back up from the cells you need to keep. Advanced. |
| reads_per_oligo | number | no | sequencing reads per guide in the readout. Joung et al. 2017 recommends >500 for a screen (>100 to QC the cloned library); the default here is the neutral 1. Advanced. |
| moi | number | no | multiplicity of infection, 0 to leave it unplanned. Joung et al. 2017 recommends <0.3 so most cells take at most one perturbation; reported, never applied. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Call HITS from a pooled CRISPR screen: per-guide read counts in, a gene-level Bayes factor and a precision/recall curve out. This is the other end of a screen from the pool designer — it reads what came back rather than deciding what to order. The estimator is BAGEL2 (Kim & Hart 2021), reproduced byte-for-byte against upstream, so a gene's Bayes factor here is the number BAGEL2 prints for the same
| Parameter | Type | Required | Notes |
|---|---|---|---|
| read_counts | string | yes | the count table: a header line, then one row per reagent — identifier, gene, then one column per sequenced sample. Tab- or comma-separated. Counts may be written as decimals, as upstream's own files a |
| essential_genes | string | yes | reference ESSENTIAL gene symbols, one per line (extra columns ignored). BAGEL2's CEGv2 is the usual choice; the editor panel ships it and the mouse set beside it. |
| non_essential_genes | string | yes | reference NON-ESSENTIAL gene symbols, one per line. BAGEL2's NEGv1 is the usual choice. |
| control_columns | array | yes | the T0 / plasmid column NAMES, exactly as the header spells them. Summed before the fold change, so a two-replicate T0 is one control and not two. |
| sample_columns | array | no | which sample column names to score. Leave empty to score every column that is not a control. |
| min_reads | number | no | drop a reagent whose SUMMED control count is below this (upstream's -m). Applied after the pseudocount, exactly as upstream applies it. |
| pseudo_count | number | no | added to every count before normalising to 10,000,000 reads per column. Advanced. |
| equalise_replicates | number | no | scale every Bayes factor as if the screen had this many replicates (upstream's -p), 0 to leave it off. A BF is a SUM over replicates, so two screens of different replicate counts are not comparable un |
| fdr_cut | number | no | the false-discovery rate the hit list is cut at. A DISPLAY threshold read off the computed curve, not a parameter of the estimator. |
| _subject | object | 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. |
| _files | array | 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. |
The complete build package for a knockout or knock-in, as one object: guides inside the target, an off-target census for the chosen one within this molecule, a repair template with real homology arms, a screening PCR whose primers sit OUTSIDE the arms, the protocol in order, the fragments and oligos to buy, and every coordinate ready for the map. Two donor modes: by default the arms sit on the cut
| Parameter | Type | Required | Notes |
|---|---|---|---|
| subject | string | no | the molecule to edit — wire a record or name a library document; leave unset to edit the open record. |
| target_start | number | yes | start of the gene to knock out (0-based, inclusive). In bp. |
| target_end | number | yes | end of the gene to knock out (0-based, exclusive). In bp. |
| target_name | string | no | what the target is called, so every mark, primer and order line names its subject. |
| arm_length | number | yes | homology-arm length on EACH side of the cut, in bp. A protocol decision that follows the delivery method, so there is no default: state what yours needs. The published working range is 100-800 (100-40 |
| screen_flank | number | yes | how far OUTSIDE the arms the screening primers must bind, in bp. Not decoration: a primer inside the arms amplifies the repair template as readily as the locus, so the assay cannot tell an edited colo |
| insert | string | no | sequence to place at the cut (a tag, a selection cassette). Leave empty for a scarless rejoin — the package then WARNS that the two screening products are the same length. |
| replace_target | boolean | no | replace the WHOLE target region with the insert, arms flanking the target — the gene-replacement donor. Off (default): the arms sit on the cut and the target's own sequence is kept on both sides of th |
| insert_name | string | no | what the insert is called in the protocol and on the order form. |
| guides | number | no | how many guides to carry into the package, best-scoring first. The rest are the alternatives, not filler. |
| nuclease | string | no | the nuclease (PAM + spacer length) to scan the target for. Values: SpCas9 (SpCas9: NGG (3')), SpCas9-NG (SpCas9-NG: NG (3')), SpG (SpG: NGN (3')), SpRY (SpRY: NRN (3')), xCas9 (xCas9: NG (3')), SaCas9 |
| max_mismatches | number | no | mismatch ceiling for the off-target search within this molecule. Advanced. |
| primer_tm | number | no | target melting temperature for the screening primers [°C] — follows your polymerase and buffer. In °C. Advanced. |
| restriction_enzymes | array | no | cloning enzymes whose recognition site must NOT appear in a spacer. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Screen guide spacers the way CHOPCHOP does before it accepts them: GC gate, self-complementary hairpins inside the spacer, and hairpins against the sgRNA backbone. A guide that folds onto its own scaffold is loaded into Cas9 poorly however good its on-target score is, so this is the check that explains a guide with a good score and no activity.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| spacers | array | yes | the protospacers to screen (20 nt for SpCas9) — wire topSpacer or the spacers out of a design run, or list them. |
| backbone | string | no | which sgRNA backbone the spacer will be cloned into — the hairpin test is against this. Values: original (original gRNA backbone), extended (extended backbone (Cas9-GFP tracking)). |
| gg | boolean | no | the construct starts the transcript GG — upstream's -gg REPLACES the spacer's first two bases with G (T7 preference), it does not lengthen it. Advanced. |
| pre_g | boolean | no | the construct prepends a single 5' G (upstream's -preG) — this one lengthens the scanned string, and upstream's fixed 17-window loop then never reaches its last bases. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Search a sequence for sites a guide could also cut, allowing mismatches, and score each one (MIT and CFD) plus the aggregate specificity of the guide WITHIN that sequence. This is specificity against what you searched — it is not a genome-wide score, and it says so rather than inventing one.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| spacer | string | yes | the protospacer to search for (20 nt for SpCas9). |
| subject | string | no | the sequence to search — wire a record or name a library document; leave unset to search the open record. |
| nuclease | string | no | which nuclease's PAM and geometry to use. Values: SpCas9 (SpCas9: NGG (3')), SpCas9-NG (SpCas9-NG: NG (3')), SpG (SpG: NGN (3')), SpRY (SpRY: NRN (3')), xCas9 (xCas9: NG (3')), SaCas9 (SaCas9: NNGRRT |
| max_mismatches | number | no | how many mismatches a site may carry and still be reported. |
| limit | number | no | cap the rows returned (hits come back worst-first: fewest mismatches). 0 = all. Advanced. |
| dna_bulge | number | no | extra bases in the DNA a site may carry (a gap opened in the guide). 0 searches mismatches only. The ceiling is the width a golden oracle covers, and a bulged hit outside that envelope reports `valida |
| rna_bulge | number | no | extra bases in the guide a site may carry (a gap opened in the DNA). Same envelope as dna_bulge. In nt. Advanced. |
| circular | boolean | no | search across the origin as well. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Count every guide's off-target sites by mismatch class across one sequence, in one pass — the question that comes BEFORE opening any single guide's site table: which of these spacers is worth looking at. Returns counts and the aggregate specificity per spacer, never the sites themselves, so a few hundred spacers cost a few hundred rows rather than a few hundred thousand.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| spacers | array | yes | the protospacers to count — wire the spacers out of a design run, or list them. |
| subject | string | no | the sequence to search — wire a record or name a library document; leave unset to search the open record. |
| nuclease | string | no | which nuclease's PAM and geometry to use. Values: SpCas9 (SpCas9: NGG (3')), SpCas9-NG (SpCas9-NG: NG (3')), SpG (SpG: NGN (3')), SpRY (SpRY: NRN (3')), xCas9 (xCas9: NG (3')), SaCas9 (SaCas9: NNGRRT |
| max_mismatches | number | no | how many mismatches a site may carry and still be counted. Every row is this many classes wide plus the exact one, so the rows line up. |
| dna_bulge | number | no | extra bases in the DNA a site may carry. 0 counts mismatches only. In nt. Advanced. |
| rna_bulge | number | no | extra bases in the guide a site may carry. Same envelope as dna_bulge. In nt. Advanced. |
| circular | boolean | no | count across the origin as well. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Fold a guide RNA — the spacer alone, and the whole sgRNA on a real published scaffold — and report which bases of the spacer pair with the scaffold. A spacer that base-pairs into the scaffold disrupts the structure Cas9 binds, which is a physical cause of a dead guide rather than a score. Every free energy is a minimum-free-energy fold under the Turner 2004 nearest-neighbour parameters, in kcal/mo
| Parameter | Type | Required | Notes |
|---|---|---|---|
| spacer | string | yes | the protospacer to fold. |
| nuclease | string | no | picks the scaffold published for that nuclease. Values: SpCas9 (SpCas9: NGG (3')), SpCas9-NG (SpCas9-NG: NG (3')), SpG (SpG: NGN (3')), SpRY (SpRY: NRN (3')), xCas9 (xCas9: NG (3')), SaCas9 (SaCas9: N |
| sg_rna | boolean | no | also fold the full spacer+scaffold sgRNA, not just the spacer. |
| _subject | object | 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. |
| _files | array | 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. |
Every sgRNA scaffold this workbench has sourced, with the nucleases each covers and the publication it comes from. A scaffold not listed here is one we do not have — the list is what we ship, not what exists.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| _subject | object | 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. |
| _files | array | 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. |
Find the splice sites a sequence accidentally spells - the check a codon-optimised CDS needs before it goes into a plant or any other eukaryotic host, because a synonymous swap chosen for codon usage or GC can spell a donor or acceptor that was not there before, and the transcript is then spliced somewhere nobody intended. Every GT and AG is scored two ways that are NOT on one scale and are never
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the DNA to scan - leave unset to use the open record. |
| strand | string | no | which strand to read. Both by default: an antisense site still splices a transcript made from the other strand, and in a construct both may be transcribed. Name the gene's own strand when you know it, |
| min_maxent | number | no | report only sites at or above this MaxEntScan score, in bits. UNSET BY DEFAULT and deliberately so - MaxEntScan publishes no significance cutoff and the measured matrices are a description rather than |
| max_results | number | no | how many to return, strongest first. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Find every place a transcription-factor binding motif (a position-frequency matrix, such as a JASPAR matrix's counts) matches a DNA sequence, on both strands, at a threshold set per motif as a fraction of that matrix's own score range. It is the scan the optimizer's avoid-motif specification counts, so the sites it lists are the ones an optimisation with that motif would remove. Each site carries
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the DNA to scan - leave unset to use the open record. |
| motifs | array | yes | the matrices, each {name, counts: {A, C, G, T} per position, relativeThreshold (0-1 of the matrix's score range) or threshold (absolute log-odds)}. Pseudocounts are JASPAR's sqrt(N) by default. |
| _subject | object | 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. |
| _files | array | 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. |
Find σ70 (housekeeping) promoters in a bacterial sequence and say how strong each one is, using the published La Fleur-Hossain-Salis biophysical model - six interaction motifs (UP element, -35, spacer, extended -10, -10, discriminator) plus the R-loop strength of the first transcribed bases, fitted on 22,132 characterised promoters. THE NUMBER IS A FREE ENERGY AND MORE NEGATIVE IS STRONGER, which
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the DNA to scan - leave unset to use the open record. |
| region_start | number | no | 0-based inclusive start of the region to scan. Unset = the whole sequence; pass the selection's start to scope to it. Advanced. |
| region_end | number | no | 0-based inclusive end. Unset = the whole sequence. Advanced. |
| both_strands | boolean | no | scan the reverse strand too. On by default: a cryptic promoter does not care which strand your insert was drawn on, and scanning one is how one gets missed. |
| max_dg | number | no | report only configurations at or below this ΔG_total. UNSET BY DEFAULT and deliberately so: this model publishes no significance cutoff, so the answer is a RANKING of the strongest configurations rath |
| max_results | number | no | how many to return, strongest (most negative) first. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Find rho-independent (intrinsic) transcription terminators in a bacterial sequence: a stem-loop followed by a thymine-rich tail, scored by TransTermHP's published model (Kingsford, Ayanbule & Salzberg 2007). TWO NUMBERS, BOTH LOWER IS STRONGER - how well the hairpin folds and how thymine-rich the tail is - and NEITHER IS A FREE ENERGY: they are costs in this model's own scheme and must not be comp
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the DNA to scan - leave unset to use the open record. |
| region_start | number | no | 0-based inclusive start of the region to scan. Unset = the whole sequence; pass the selection's start to scope to it. Advanced. |
| region_end | number | no | 0-based inclusive end. Unset = the whole sequence. Advanced. |
| both_strands | boolean | no | scan the reverse strand too. On by default: a terminator on the strand you did not draw still stops transcription that runs into it. |
| max_results | number | no | how many to return, best hairpin first. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Score the ribosome-binding site already in front of a start codon: the Shine-Dalgarno hybridisation energy, the mRNA folding that competes with it, the spacing it implies, and the resulting relative initiation strength. This reads an existing 5'UTR — design_rbs writes a new one.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| mrna | string | no | the mRNA (or DNA) carrying the UTR and the CDS — leave unset to use the open record. |
| start_pos | number | yes | 0-based position of the start codon's first base within mrna. |
| _subject | object | 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. |
| _files | array | 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. |
Stack several CDSs into one contiguous operon, designing a fresh ribosome-binding site in front of each one AGAINST ITS REAL UPSTREAM CONTEXT — which is why the RBS for gene 2 is not the RBS design_rbs would give it in isolation. Returns the assembled sequence, its layout, and each gene's achieved strength.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| cds | array | yes | the coding sequences to stack, in order — wire upstream record outputs here, or name library documents. |
| include_subject | boolean | no | put the node's subject first, as the first gene. |
| target_strength | number | no | relative initiation strength to aim for at every gene, on the model's own scale — 1 is as strong as its reference site. Overridden per gene by target_strengths. |
| target_strengths | array | no | per-gene target strengths, aligned to cds — the Operon panel gives every row its own, and a run through this door could not say the same thing. Shorter than cds falls back to target_strength for |
| promoter | string | no | promoter sequence to place in front of the operon (optional). Advanced. |
| terminator | string | no | terminator sequence to place after the last gene (optional). Advanced. |
| leader | string | no | leader placed before the FIRST ribosome-binding site (defaults to the design leader). Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Codon-usage analysis of an in-frame CDS: CAI / expression stats, GC, and every rare-codon occurrence for the chosen organism (pydna port), plus the two bias measures that need NO reference table — ENC (Wright 1990) and RCBS (Roymondal 2009), which are therefore computable for any organism.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| organism | string | no | reference organism for CAI weights + rare codons. Only some organisms carry CAI weights; the rest still get the rare-codon scan + GC. |
| reverse | boolean | no | read the region as the reverse complement. Leave unset to take the strand from the annotation when the selection is exactly an annotated CDS or gene, which is what the panel does. |
| feature | string | no | score this annotated CDS or gene by NAME instead of the selection (the panel's "A CDS / feature…" mode). Its own strand is used unless reverse says otherwise. |
| table | string | no | score CAI and rare codons against a codon-usage table this project holds, BY NAME, as the Codon Usage panel lists it — any organism, not just the two pydna curates. Takes precedence over organism, a |
| rare_threshold | number | no | a codon is rare when its relative adaptiveness w = f/f_max falls below this. 0.30 is GenScript GenRCA's CFD cutoff, a convention rather than a measurement, so retune it per host. Only applies when tab |
| enc_bg_correction | boolean | no | correct ENC for the sequence's own base composition (Novembre 2002). Off is Wright's 1990 ENC, which reads GC-rich genes as more biased than they are. |
| enc_pairs | boolean | no | count codon PAIRS rather than single codons for ENC (k-mer 2) — bias in the junctions rather than in the codons. |
| rcbs_directional | boolean | no | RCBS weights taken as max(observed/expected, expected/observed), so under-use counts as bias too rather than only over-use. |
| rcbs_mean | string | no | how the per-codon RCBS weights are averaged. Roymondal 2009 uses the geometric mean. Values: geometric (Geometric (Roymondal 2009)), arithmetic (Arithmetic). |
| _subject | object | 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. |
| _files | array | 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. |
How this region's codon usage compares with the record's OTHER genes (CUFS, Diament, Pinter & Tuller 2014). Every other codon score grades one sequence against a reference TABLE; this one grades two sequences against each other, so it stays available for an organism no authority covers. Answers 'does the gene I inserted use codons like the rest of this construct'.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| synonymous | boolean | no | normalise each amino acid's codons to sum to 1 (synCUFS), so what remains is the synonymous choice alone. Off compares all 64 codon frequencies, which also reflects amino-acid composition. |
| reverse | boolean | no | read the region as the reverse complement. Leave unset to take the strand from the annotation when the selection is exactly an annotated CDS or gene, which is what the panel does. |
| feature | string | no | score this annotated CDS or gene by NAME instead of the selection (the panel's "A CDS / feature…" mode). Its own strand is used unless reverse says otherwise. |
| _subject | object | 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. |
| _files | array | 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. |
Decide whether a sequence is scientifically admissible: protein unchanged, forbidden restriction sites absent, reading frame intact, length/GC/CAI inside stated bounds. Every verdict names what broke, where, and the remedy. Run this after any design or optimisation step, and stop the chain when admissible is false — never report a designed sequence without it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the sequence to judge — defaults to the open record. |
| preserve_protein_of | string | no | the ORIGINAL coding sequence (or its protein): the result must still translate to it. |
| forbid_sites | array | no | enzyme names that must not cut, e.g. BsaI, BsmBI. |
| require_frame | boolean | no | length divisible by 3 and no premature stop. |
| require_start | boolean | no | with require_frame: the first codon must be a start codon. Only applies when require_frame is true. Advanced. |
| require_stop | boolean | no | with require_frame: the last codon must be a stop. Only applies when require_frame is true. Advanced. |
| min_length | number | no | minimum length [bp]. In bp. Advanced. |
| max_length | number | no | maximum length [bp]. In bp. Advanced. |
| min_gc | number | no | minimum GC fraction (0-1). |
| max_gc | number | no | maximum GC fraction (0-1). |
| gc_window | number | no | judge every window of this many bases instead of the whole sequence — a synthesis is rejected on a local GC peak, not on the mean. In bp. Advanced. |
| cai_organism | string | no | host for the codon-adaptation check, e.g. sce. Advanced. |
| min_cai | number | no | minimum CAI (needs cai_organism). Advanced. |
| table | number | no | NCBI translation table. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
The expression-design deliverable: several coding sequences for one protein, each variant following a different published strategy (maximise codon adaptation, match the host's codon usage, harmonise with the native host, or preserve the initiation region), each scored by an engine — CAI, GC, the folding energy of the Kudla -4..+37 initiation window, and rare codons. It returns the comparison rathe
| Parameter | Type | Required | Notes |
|---|---|---|---|
| cds | string | no | the coding sequence to redesign, in frame and start-codon first. Unset falls back to THE SELECTION, on the strand the selection or its matching annotation states, then to the whole open record. |
| feature | string | no | redesign this annotated CDS or gene by NAME instead of the selection, exactly as codon_usage_analysis takes one. Its own strand is used. Takes precedence over the selection; cds still wins over bo |
| host_table | string | no | the TARGET host's codon-usage table, BY NAME, as the Codon Usage panel lists it. This is the way to pass a table: it resolves against the tables loaded in this project, so the numbers come from a tabl |
| host_table_tsv | string | no | ONLY for a table you are pasting yourself, measured elsewhere — prefer host_table, which names one this project already has. Do NOT write a table out from memory: codon frequencies are measured data |
| host_table_name | string | no | how to name that table on every score it produced (e.g. "E. coli K-12, Kazusa"), so a reported CAI is attributable. |
| postures | array | yes | which strategies to design, in order. max_cai = every amino acid takes the target host's single most-used codon; match_usage = reproduce the target host's synonymous-codon distribution rather than its |
| native_table | string | no | the gene's NATIVE host codon table, BY NAME from this project's loaded tables — required only for the harmonize posture, which matches relative adaptiveness BETWEEN two hosts. It must be a DIFFERENT |
| native_table_tsv | string | no | ONLY for a native table you are pasting yourself — prefer native_table. Do not write one out from memory (see host_table_tsv). TSV: codon<TAB>count. Advanced. |
| upstream | string | no | the bases immediately 5' of the CDS (the 5'UTR/RBS region). Kudla's window starts 4 nt BEFORE the start codon, so without this the folding energy is reported over a truncated window and says so. |
| rare_below | number | no | within-family frequency below which a codon counts as RARE, for the report only — it adds no constraint. Omit and no rare-codon count is reported, which is the honest answer: "rare" has no host-indepe |
| genetic_table | string | no | genetic code for the translation constraint (default Standard). Advanced. |
| avoid_patterns | array | no | literal patterns (restriction sites, homopolymers) every variant must not contain. |
| gc_min | number | no | minimum GC fraction (0-1); set with gc_max. Advanced. |
| gc_max | number | no | maximum GC fraction (0-1); set with gc_min. Advanced. |
| gc_window | number | no | window in bp the GC bounds apply over (whole sequence when unset). Advanced. |
| seed | number | no | seed for the solver's random draws, so a listed variant can be regenerated exactly. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Run the DnaChisel optimizer over the subject with real constraints/objectives (GC window, pattern avoidance, translation enforcement, …). Emits the optimized sequence as a NEW record for downstream nodes.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| constraints | array | no | DnaChisel constraint specs, e.g. [{"kind":"EnforceGCContent","mini":0.4,"maxi":0.6,"window":50}] — hard requirements the solution must satisfy. Valid kind values: EnforceTranslation, AvoidPattern, E |
| objectives | array | no | DnaChisel objective specs — soft goals the solver maximises. Same kind values as constraints: EnforceTranslation, AvoidPattern, EnforceGCContent, AvoidHairpins, AvoidRareCodons, UniquifyAllKmers, Co |
| candidates | number | no | how many alternative solutions to produce (1 = a single solve). Candidate 1 is the plain unseeded answer; the rest run at seed+1, seed+2, …, so a listed alternative can be asked for again. Max 12. |
| seed | number | no | base seed for the alternatives — the same seed returns the same set. Advanced. |
| randomization_threshold | number | no | DnaChisel randomization_threshold (default 10000). LOWER it to force the stochastic search: an objective-driven problem is deterministic, so without this every candidate comes back identical. Advanc |
| _subject | object | 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. |
| _files | array | 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. |
Design a 5'UTR (Shine-Dalgarno + spacer) in front of a CDS to hit a target translation-initiation strength (SC-08 engine, Turner-2004 folding).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| cds | string | no | the CDS starting at its start codon; unset = the open record's sequence. |
| target_strength | number | yes | target relative strength, on the model's own scale — 1 is as strong as its reference site, and real sites do score above it. |
| upstream | string | no | upstream context 5' of the UTR (engine default when unset). Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Design LAMP (loop-mediated isothermal amplification) primer SETS - four core oligos (F3 · B3 · FIP · BIP) plus optional loop primers, judged against Eiken's own PrimerExplorer V5 criteria. Not a pair: LAMP needs six binding regions in the published order and the distances BETWEEN them are as much of the design as the oligos. Each set comes back with the arithmetic behind its rank.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| region_start | number | no | 0-based inclusive start of the region to design into (LAMP designs into a stretch, not a whole plasmid). Unset = the whole sequence; pass the selection's start to scope to it. Advanced. |
| region_end | number | no | 0-based inclusive end. Unset = the whole sequence. Advanced. |
| max_sets | number | no | how many sets to return, best first. |
| loop_primers | boolean | no | design LF/LB as well. They are optional in LAMP and accelerate the reaction. |
| end_stability_dg | number | no | the terminal-6-base stability rule (manual §2.2: the ΔG "is -4 kcal/mol or less"). In kcal/mol. Advanced. |
| end_stability_nt | number | no | how many terminal bases the end-stability rule measures (manual §2.2: 6). In nt. Advanced. |
| length_min | number | no | length window for the outer/inner binding regions (manual §4.2) - lower bound. Unset = the preset for this template's GC class. In nt. Advanced. |
| length_max | number | no | length window for the outer/inner binding regions (manual §4.2) - upper bound. Unset = the preset for this template's GC class. In nt. Advanced. |
| tm_inner_min | number | no | Tm window for F1c / B1c - the manual's "about 65 °C" - lower bound. Unset = the preset for this template's GC class. In °C. Advanced. |
| tm_inner_max | number | no | Tm window for F1c / B1c - the manual's "about 65 °C" - upper bound. Unset = the preset for this template's GC class. In °C. Advanced. |
| tm_outer_min | number | no | Tm window for F2 / B2 / F3 / B3 - the manual's "about 60 °C" - lower bound. Unset = the preset for this template's GC class. In °C. Advanced. |
| tm_outer_max | number | no | Tm window for F2 / B2 / F3 / B3 - the manual's "about 60 °C" - upper bound. Unset = the preset for this template's GC class. In °C. Advanced. |
| tm_loop_min | number | no | Tm window for the loop primers LF / LB - lower bound. Unset = the preset for this template's GC class. In °C. Advanced. |
| tm_loop_max | number | no | Tm window for the loop primers LF / LB - upper bound. Unset = the preset for this template's GC class. In °C. Advanced. |
| gc_min | number | no | GC FRACTION window, 0-1 (manual §2.3: "between about 40% to 65%") - lower bound. Unset = the preset for this template's GC class. Advanced. |
| gc_max | number | no | GC FRACTION window, 0-1 (manual §2.3: "between about 40% to 65%") - upper bound. Unset = the preset for this template's GC class. Advanced. |
| amplified_span_min | number | no | F2 5' to B2 5', the amplified region. THE TWO AUTHORITIES DISAGREE: PrimerExplorer V5 says 120-160, the Eiken genome site 120-180; the default follows PrimerExplorer and this is the knob for the other |
| amplified_span_max | number | no | F2 5' to B2 5', the amplified region. THE TWO AUTHORITIES DISAGREE: PrimerExplorer V5 says 120-160, the Eiken genome site 120-180; the default follows PrimerExplorer and this is the knob for the other |
| loop_span_min | number | no | 5' of F2 to 5' of F1 - the portion that forms the loop (manual §2.5: 40-60) - lower bound. Unset = the preset for this template's GC class. In bp. Advanced. |
| loop_span_max | number | no | 5' of F2 to 5' of F1 - the portion that forms the loop (manual §2.5: 40-60) - upper bound. Unset = the preset for this template's GC class. In bp. Advanced. |
Design CODEHOP hybrid oligos from a block of aligned PROTEIN - for homologues too diverged for nucleotide-level design to see at all. Each primer is a 3' DEGENERATE core over a few conserved residues fused to a 5' non-degenerate consensus clamp, back-translated through a codon-usage table. A different algorithm from the degenerate designer, not a variant of it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| alignment | array | no | the ALIGNED PROTEIN rows, each { name, sequence } in one-letter amino acids with gaps preserved - wire an upstream protein alignment here. At least 3 sequences: the clamp is a CONSENSUS, and two have |
| alignment_fasta | string | no | an aligned PROTEIN FASTA, when there is no upstream alignment to wire. |
| table | string | yes | the codon-usage table to back-translate the clamp through, BY NAME as the Codon Usage panel lists it. REQUIRED and deliberately without a default: a CODEHOP designed under the wrong organism's usage i |
| block_index | number | no | which gapless block to design in, 0-based, ordered as gaplessBlocks returns them (blocks of at least 8 ungapped columns). Unset = the first. |
| strand | string | no | which strand to design on. both returns forward and reverse sets, which is what a PCR needs. |
| max_core_degeneracy | number | no | degeneracy ceiling for the 3' core (Rose 2003 step 7: "a maximum degeneracy of 128"). |
| clamp_tm | number | no | target melting temperature for the non-degenerate 5' clamp (Rose 2003 step 8: "the current default is 60 °C, which usually provides a clamp of ~20 nucleotides"), measured as nearest-neighbour Tm in th |
| conditions | object | no | salt, magnesium, dNTP and oligo concentrations plus the salt-correction method and any additives the clamp Tm is measured in. Left unset it is filled from your reaction-conditions settings, and falls |
| max_run | number | no | longest single-base run allowed; 2003's stated polynucleotide run limit. A primer exceeding it is rejected. In nt. Advanced. |
| base_cutoff | number | no | minimum predicted probability for a base to enter the degenerate core. Advanced. |
| max_clamp_length | number | no | ceiling on clamp growth, so an unreachable Tm REFUSES instead of consuming the whole block. Ours, and a stop condition rather than a published criterion - 40 nt is already twice the ~20 the paper expe |
| genetic_code_id | number | no | NCBI transl_table id for the codon-to-residue map. Advanced. |
| core_lengths | array | no | core lengths the scan tries, in residues — every length here is scanned and the best-scoring core kept. Advanced. |
| weighting | string | no | how the alignment's rows are weighted before the core's consensus is read. Values: pb (Position-based (Henikoff & Henikoff 1994)), none (None — every row counts once). Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Design degenerate primers from a multiple-sequence ALIGNMENT - the 'amplify every homologue in this family' question, which a single-template designer cannot answer because it only ever sees one sequence. A faithful port of DegePrime (Hugerth et al. 2014). Wire an upstream align_sequences rows output straight in, or paste an aligned FASTA.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| alignment | array | no | the ALIGNED rows to scan, each { name, sequence } with gaps preserved - wire an upstream align_sequences rows output here. Gaps carry information the scan reads, so an unaligned set is not a subst |
| alignment_fasta | string | no | an aligned FASTA to scan, when there is no upstream alignment to wire. Sequences must already BE aligned - equal length, gaps as -. |
| algorithm | string | no | which search picks each window's oligo. wrm is DegePrime's own default and is randomised (hence seed); exhaustive is an exact branch-and-bound that GRADES the heuristics rather than letting them |
| length | number | no | oligomer length (DegePrime -l). In nt. |
| max_degeneracy | number | no | degeneracy ceiling (-d) - how many distinct oligos the IUPAC code is allowed to stand for. Coerced DOWN when no combination of positions can multiply to it, and the run says so. |
| min_product | number | no | shortest product, in TRIMMED alignment columns. In col. |
| max_product | number | no | longest product, in TRIMMED alignment columns. In col. |
| min_fraction_matching | number | no | a window must bind at least this fraction of the spanning sequences to be a candidate - the coverage floor, and the number that decides whether 'every homologue' is true. |
| trim_cutoff | number | no | columns occupied by less than this fraction of sequences are dropped before scanning. Trimming renumbers the alignment, which is why keptColumns comes back with the result. Advanced. |
| min_depth | number | no | fewest gapless sequences a window needs before it is reported at all (-depth). Advanced. |
| skip | number | no | bases excluded at each end of every sequence (-skip). In nt. Advanced. |
| iterations | number | no | WRM restarts (-iter). Only applies when algorithm is wrm. Advanced. |
| seed | number | no | seed for WRM's draw, so a run is REPRODUCIBLE. Upstream is unseeded, so the same alignment can give two answers; a design you cannot reproduce is not one you can order from. Only applies when algorith |
| exhaustive_mer_limit | number | no | largest number of distinct mers exhaustive will attempt before refusing a window. Only applies when algorithm is exhaustive. Advanced. |
| limit | number | no | how many pairs to return, best coverage first. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Design BSP or MSP primers for a methylation assay, on the CONVERTED strands: after bisulfite treatment every unmethylated C reads as T, which is a different template from the one every other designer sees. BSP primers avoid CpGs so they amplify regardless of methylation state; MSP primers sit ON CpGs so they discriminate. Also reports the CpG islands (EMBOSS cpgplot) the assay should target.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| assay | string | no | BSP = bisulfite sequencing PCR: primers avoid CpG sites so both methylated and unmethylated template amplify equally, and the methylation is read from the SEQUENCE afterwards. MSP = methylation-specif |
| max_results | number | no | how many primer pairs to return, best first. |
| region_start | number | no | 0-based inclusive start of the region to design in. Unset = the whole sequence; pass the selection's start to scope to it. Advanced. |
| region_end | number | no | 0-based inclusive end. Unset = the whole sequence. Advanced. |
| criteria | string | no | which published criteria call a CpG island: Gardiner-Garden & Frommer 1987 as EMBOSS cpgplot encodes it, or the stricter Takai & Jones 2002, which excludes most Alu repeats. Values: cpgplot (Gardiner- |
| island_window | number | no | sliding window over which C, G and CpG are counted (cpgplot -window); unset takes the preset's. In bp. Advanced. |
| island_min_length | number | no | minimum island length (cpgplot -minlen); unset takes the preset's. In bp. Advanced. |
| island_min_obs_exp | number | no | minimum observed/expected CpG (cpgplot -minoe); unset takes the preset's. Advanced. |
| island_min_percent | number | no | minimum %C+%G (cpgplot -minpc); unset takes the preset's. In %. Advanced. |
| design_in_island | number | no | design inside this island only, by its rank in the reported list (1 = first). Unset designs anywhere in the region; the panel instead asks for an island to be picked. |
| min_length | number | no | shortest primer considered. In nt. Advanced. |
| opt_length | number | no | primer length the ranking prefers. In nt. |
| max_length | number | no | longest primer considered. In nt. Advanced. |
| min_tm | number | no | primers below this Tm are rejected outright. In °C. Advanced. |
| opt_tm | number | no | target Tm; candidates rank by distance from it. Bisulfite-converted DNA is C-poor, so these run lower than an ordinary design. In °C. |
| max_tm | number | no | primers above this Tm are rejected outright. In °C. Advanced. |
| min_gc | number | no | lowest acceptable GC. The floor is low on purpose: after conversion every unmethylated C is a T, so converted DNA is genuinely GC-poor and an ordinary 40% floor rejects correct primers. In %. Advanced |
| max_gc | number | no | highest acceptable GC. In %. Advanced. |
| product_min | number | no | shortest acceptable amplicon. In bp. |
| product_max | number | no | longest acceptable amplicon. In bp. |
Design a WALK of sequencing primers that reads a whole region, not one pair: tiled reads with confirmed overlap, on both strands by default, plus the coverage the walk actually achieves and any stretch it cannot reach. This is the 'how do I read all 6 kb of this construct' question, which a single pair does not answer. Read length and dead zone default to a named facility's published figures (MSU
| Parameter | Type | Required | Notes |
|---|---|---|---|
| read_length | number | no | usable bases per read, AFTER the dead zone. Default 800 is the shortest read MSU RTSF Genomics Core, Sanger Sequencing Best and Worst Practices (2024-04-25), ABI 3730XL promises (it quotes 800-900), w |
| dead_zone | number | no | bases at the start of a read that are not trustworthy. Default 35 is the LONGEST the same source warns about (it says the first 25-35 bases are poor), so an untouched walk is the cautious reading in b |
| overlap | number | no | confirmed overlap required between consecutive reads on one strand. Overlap is what turns abutting reads into a contig. Default 100 has NO published source and is a judgement, which is why it is state |
| both_strands | boolean | no | read every base from both directions - what a sequencing facility means by double-stranded coverage, and the standard for anything deposited or published. |
| region_start | number | no | 0-based inclusive start of the region to read. Unset = the whole template. Advanced. |
| region_end | number | no | 0-based inclusive end of the region to read. Unset = the whole template. Advanced. |
| target_tm | number | no | target melting temperature for each primer in the walk. In °C. Advanced. |
| min_length | number | no | shortest acceptable primer. In bp. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Design a forward + reverse primer pair to amplify the subject (pydna primer_design), with Tm, Ta and suggested Taq/Phusion cycling programs. Emits both primers so a downstream pcr_amplify runs on them — the design→PCR→gel loop.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target_tm | number | no | target melting temperature (pydna default 55). In °C. |
| conditions | object | no | salt, magnesium, dNTP and oligo concentrations plus the salt-correction method and any additives the target Tm is measured in. Left unset it is filled from your reaction-conditions settings, and falls |
| limit | number | no | minimum primer length (pydna limit). In bp. Advanced. |
| forward_primer | string | no | supply one primer to design only its mate. Advanced. |
| reverse_primer | string | no | supply one primer to design only its mate. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Multiple-sequence alignment over several sequences, under either of TWO engines that answer different questions and neither of which is a fallback for the other. poa (partial-order, poapy) aligns into a graph, keeps every path a read took and produces its own consensus row — what a pile of reads over one locus wants. progressive (biotite) computes Feng-Doolittle distances, clusters them into a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequences | array | no | the sequences to align — wire several upstream outputs here, or list library document names/ids. |
| include_subject | boolean | no | also align the node's subject (the open or wired record). |
| engine | string | no | which aligner builds the alignment. They answer DIFFERENT questions: poa keeps every path through a pile of reads and emits its own consensus row, progressive merges a family along a guide tree th |
| global_align | boolean | no | global alignment rather than local. Poapy's own default is LOCAL; both this tool and the MSA inspector open on global, which is the choice a full-length comparison wants - switch it off for reads over |
| match | number | no | poa only: score for a pair of identical symbols. Only applies when engine is poa. Advanced. |
| mismatch | number | no | poa only: score for a mismatching pair. Negative. Only applies when engine is poa. Advanced. |
| gap | number | no | poa only: score for a gap column. Negative. Only applies when engine is poa. Advanced. |
| align_matrix | string | no | progressive only: the substitution matrix the ALIGNMENT itself is scored with - distinct from score_matrix, which only scores the quality report afterwards. auto reads the alphabet: EDNAFULL for |
| guide_tree | string | no | progressive only: which tree the merge follows. The Feng-Doolittle distances are the aligner's either way; this chooses only how they are clustered into an order. UPGMA is biotite's own and the one |
| affine_gap | boolean | no | progressive only: false charges one flat penalty per gap column; true charges separate opening and extension penalties, which is what keeps a real indel as ONE gap instead of many. Only applies |
| gap_penalty | number | no | progressive only: the flat penalty per gap column. Negative. Only applies when affine_gap is false. |
| gap_open | number | no | progressive, affine only: the penalty for STARTING a gap. Negative. Only applies when affine_gap is true. |
| gap_extend | number | no | progressive, affine only: the penalty for each column a gap is extended by. Negative, and gentler than gap_open - an extension harsher than the opening makes the aligner prefer many short gaps to |
| terminal_penalty | boolean | no | progressive only: true charges overhanging ends like an internal gap - right for full-length homologues. false makes them free, which is right when a sequence covers only part of the region, e.g |
| score_matrix | string | no | substitution matrix for the pyMSA sum-of-pairs and star scores in the quality report. Both engines. Left unset only the matrix-free scores are computed (entropy, % non-gaps, % totally conserved column |
| _subject | object | 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. |
| _files | array | 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. |
Draw a block of an alignment as an SVG figure: the rows named, the residues shaded by how much of their column agrees with them, the column numbers over the block and Easel's Clustal conservation line under it. Wire alignedSequences from align_sequences. Name the window around whatever you are asking about — a variable site, a motif, a gap — because a 2,000-column alignment drawn at once shows n
| Parameter | Type | Required | Notes |
|---|---|---|---|
| rows | array | yes | the ALIGNED rows, each {name, aligned}; every row must already be the same length. Wire alignedSequences from align_sequences. |
| from | number | no | first column drawn, 1-based and inclusive. Clamped into the alignment. |
| columns | number | no | how many columns to draw. Past about 200 the letters are narrower than the strokes that make them. |
| scheme | string | no | identity shades a residue by how much of its column agrees with it, which works for any alphabet; nucleotide paints QUEEN's own base colours and is IGNORED over protein rows, which the answer's `schem |
| cell_width | number | no | width of one column's cell. In px. Advanced. |
| row_height | number | no | height of one row. In px. Advanced. |
| name_chars | number | no | how many characters of a row's name to print; a longer one is elided in the middle, keeping the tail where two rows of a family differ. Advanced. |
| conservation | boolean | no | print the conservation line under the block. |
| ruler | boolean | no | print the column numbers over the block. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Find the rows of an alignment that repeat another: each row's redundancy is its highest percent identity to a row at least as long (ungapped residues), and a row at or above the threshold is redundant, so filtering keeps the longest representative of each near-identical group. Jalview's definition: a gap matches anything and the pair is compared over the shorter row. Wire alignedSequences from a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| rows | array | yes | the ALIGNED rows, each {name, aligned}. Wire alignedSequences from align_sequences. |
| threshold | number | no | percent identity at or above which a row is redundant. In %. |
| from | number | no | first column compared, 1-based inclusive. Advanced. |
| to | number | no | last column compared, 1-based inclusive; 0 means the last column. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Principal component analysis of the rows of an alignment: the pairwise similarity of every two rows under PID or a substitution matrix (BLOSUM62, PAM250 for protein; Jalview's DNA matrix for nucleotides), decomposed into eigenvectors, and each row's coordinate on the leading components, so rows that cluster sit together. Jalview's PCA, with its parameters: gap–gap and gap–residue columns counted,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| rows | array | yes | the ALIGNED rows, each {name, aligned}. Wire alignedSequences from align_sequences. |
| model | string | no | the similarity model: PID for any alphabet, BLOSUM62 or PAM250 for protein, DNA for nucleotides. Values: PID (Percent identity), BLOSUM62 (BLOSUM62), PAM250 (PAM250), DNA (DNA). |
| components | number | no | how many leading components to report per row. |
| _subject | object | 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. |
| _files | array | 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. |
Read the consensus RNA secondary structure a Stockholm alignment states in its #=GC SS_cons line (WUSS, the notation Rfam and Infernal write), and measure how well the aligned rows actually support it. Reports the base pairs, what each unpaired column is (hairpin, bulge, multifurcation, external, insertion, local end), and per pair the fraction of rows whose two bases form a canonical or GU wobb
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | the alignment file's contents. Stockholm is the only format that records #=GC annotation, so a CLUSTAL or PHYLIP file is refused by name rather than returning an empty structure. |
| _subject | object | 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. |
| _files | array | 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. |
Assemble fragments by terminal homology (Gibson / NEBuilder / In-Fusion, DnaCauldron). Emits the first product as a NEW record for downstream nodes.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fragments | array | no | the fragments to assemble — wire upstream record outputs here, or list library document names/ids. |
| include_subject | boolean | no | also include the node's subject as a fragment. |
| min_homology_bp | number | no | minimum terminal homology for two ends to join. In bp. |
| max_homology_bp | number | no | longest terminal homology considered. The bound is EXCLUSIVE, as upstream's own range(min, max) is: a maximum of 40 rejects a 40 bp arm. In bp. |
| min_tm | number | no | optional floor on the junction's GATE value (DnaCauldron's naive A/T = 2, G/C = 4 sum, not a nearest-neighbour temperature). 0 = no constraint. In °C. Advanced. |
| max_tm | number | no | optional ceiling on the same gate scale. 0 = no constraint. In °C. Advanced. |
| topology | string | no | product topology to enumerate. Values: circular (Circular), linear (Linear), both (Both). |
| preserve_backbone_origin | boolean | no | for circular products, rotate the origin to the start of the backbone fragment and name the product after it. Advanced. |
| expect_no_unused_parts | boolean | no | treat a fragment left out of every construct as an error rather than a warning (upstream's own default). |
| max_constructs | number | no | cap on how many distinct constructs are enumerated, so an ambiguous fragment set cannot run away. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Open ONE circular backbone at several places and place several inserts in a single step. A complete digest at n sites leaves n arcs and n gaps between them, and every gap has to be filled for the ring to close; the arcs and the inserts go to the same homology assembler the single-insert tool uses, and which insert lands in which gap is read off each construct the homology graph closes rather than
| Parameter | Type | Required | Notes |
|---|---|---|---|
| backbone | string | no | the circular vector to open. Leave unset to use the open record. |
| enzymes | array | yes | the enzymes that open the backbone, by name (1409 in the cloning catalogue). Their sites ARE the insertion points, so two single-cutters give two of them; a name the catalogue does not carry is refuse |
| inserts | array | yes | the fragments to place, one per insertion point — wire upstream record outputs here, or name library documents. |
| min_homology_bp | number | no | minimum terminal homology for two ends to join. In bp. |
| max_homology_bp | number | no | longest terminal homology considered; the bound is EXCLUSIVE, as upstream's own range is. In bp. |
| max_constructs | number | no | cap on how many distinct constructs are enumerated. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Design the PCR primers that CREATE the terminal homology a Gibson/NEBuilder/In-Fusion assembly needs: a Tm-matched pair per fragment, each carrying the 5' overhang that fuses it to its neighbour in the order given (pydna assembly_fragments). This is the step that turns a planned assembly into oligos you can order.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fragments | array | no | the fragments to join, IN ASSEMBLY ORDER — wire upstream record outputs here, or list library document names/ids. |
| include_subject | boolean | no | put the node's subject first, as the backbone. |
| target_tm | number | no | target annealing Tm for each primer's 3' footprint. In °C. |
| overlap | number | no | homology shared between two adjacent fragments. pydna splits it across the junction, so each primer's 5' tail is about half this. In bp. |
| circular | boolean | no | close the ring: the last fragment also overlaps the first. |
| min_footprint | number | no | shortest annealing footprint the designer may settle for (pydna's limit). In nt. Advanced. |
| synthesis_scale | string | no | catalogue product to price the oligos at (an oligo-list-prices record id); auto prices each at the cheapest product whose published length range covers it. Advanced. |
| conditions | object | no | salt, magnesium, dNTP and oligo concentrations plus the salt-correction method the target Tm is measured in. Left unset it is filled from your reaction-conditions settings, and falls back to pydna's T |
| _subject | object | 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. |
| _files | array | 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. |
Assemble parts with a Type-IIS enzyme (Golden Gate / MoClo, DnaCauldron). Emits the first construct as a NEW record for downstream nodes.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| parts | array | no | the parts to assemble — wire upstream record outputs here, or list library document names/ids. |
| include_subject | boolean | no | also include the node's subject as a part. |
| enzyme | string | no | Type-IIS enzyme, or leave unset to let DnaCauldron pick one. |
| connectors | array | no | candidate bridging LINKERS, a library distinct from parts. The engine reaches for one as a FALLBACK, where the parts alone do not close a construct, and names the ones it added in warnings; a cand |
| expected_constructs | number | no | expect exactly this many constructs and fail when the count differs. Leave unset to enumerate every valid one. |
| expect_no_unused_parts | boolean | no | treat a part the assembly did not consume as an error, which is DnaCauldron's own default. |
| max_constructs | number | no | cap on enumerated constructs. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Check parts BEFORE a Type-IIS assembly: how many recognition sites each carries, which of them are the two deliberate flanking sites and which are internal sites that will mis-cut the part. This is what answers “why will this assembly not work” — an internal site has to be domesticated (silently recoded) before the reaction can be trusted.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| parts | array | no | the parts to check — wire upstream record outputs here, or list library document names/ids. |
| include_subject | boolean | no | also check the node's subject. |
| enzyme | string | no | the Type-IIS enzyme the assembly will use. |
| _subject | object | 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. |
| _files | array | 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. |
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
| Parameter | Type | Required | Notes |
|---|---|---|---|
| overhangs | array | yes | the junction overhangs, one per junction, top strand (e.g. AATG, GCTT). Wire golden_gate_assemble.overhangs here, or list them. |
| enzyme | string | 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 | string | 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, Gold |
| remedies | boolean | 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. |
| replacements_per_junction | number | no | how many replacement candidates to rank per flagged junction. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Decide where to CUT one sequence into Golden Gate fragments, optimising the split positions and the overhangs they create together. Where design_overhang_set proposes junctions for parts you already have, this fragments a sequence you are about to order: it searches every legal arrangement of fragments in your length window and ranks them by the measured ligation efficiency and fidelity of the ove
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the sequence to fragment, in one piece. Leave it empty to fragment the open record. |
| min_length | number | no | shortest allowed fragment, in bases — usually what your synthesis vendor will accept. |
| max_length | number | no | longest allowed fragment, in bases — the vendor's upper limit, or the length you can sequence in one read. |
| traces | number | no | how many ranked alternatives to return. The best arrangement is rarely the only acceptable one, and the runner-up often avoids a site you care about. |
| fragments | number | no | pin the number of fragments instead of letting the search choose. Leave empty to take whatever the length window allows. |
| efficiency_weight | number | no | exponent on the running ligation EFFICIENCY — raise it to favour junctions that ligate readily. Efficiency and fidelity are different failure modes: a junction can ligate eagerly and promiscuously. Ad |
| fidelity_weight | number | no | exponent on the running FIDELITY — raise it to favour junctions that ligate to the right partner rather than a mismatched one. Advanced. |
| max_overhang_identity | number | no | most positions two overhangs in the set may share before they are treated as confusable. Lower is stricter and rules out more arrangements. Advanced. |
| alien_overhangs | array | no | junctions already committed elsewhere in the assembly (a fixed vector's own ends), which this set must not collide with. Advanced. |
| exclude_from | number | no | start of a span no cut may fall in — a feature you need kept intact. Use with exclude_to. Advanced. |
| exclude_to | number | no | end of that span, exclusive. Only applies when exclude_from is set. Advanced. |
| dataset | string | no | the measured ligation matrix to score against. OOGGA's own published choice is the T4 18 h 37 C set. Values: BsaI-HFv2 (BsaI-HFv2, Golden Gate cycling (4 nt)), BsmBI-v2 (BsmBI-v2, Golden Gate cycling |
| _subject | object | 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. |
| _files | array | 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. |
Design a high-fidelity Golden Gate overhang set of a given size against measured ligation data, optionally pinning junctions you cannot change (a fixed vector's own overhangs). The counterpart to score_overhang_fidelity: that grades a set you already have, this proposes one. The search is greedy-plus-steepest-ascent over the same golden-validated objective: real measured data, a heuristic path, no
| Parameter | Type | Required | Notes |
|---|---|---|---|
| size | number | no | how many junctions the assembly needs (parts + 1 for a circular construct, counted as junctions). |
| fixed | array | no | junctions you cannot change, such as a destination vector's own overhangs. They are never considered for replacement and are counted inside size. |
| enzyme | string | 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 | string | no | design 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, Gol |
| start_from | array | no | the set you already have, as a second starting point. Given one of the same size, the answer is never WORSE than it: the greedy build alone can land in its own basin and lose points against a real set |
| candidate_pool | number | no | how many of the strongest-annealing overhangs the search considers. Higher is a better set and a slower run. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Run a MULTI-LEVEL assembly plan (DnaCauldron AssemblyPlan): several assemblies arranged into dependency levels, where each level's products become parts for the next. Emits the FINAL construct as a record. The plan is DnaCauldron's own spreadsheet shape — one row per construct, construct_name, part, part, ….
| Parameter | Type | Required | Notes |
|---|---|---|---|
| parts | array | no | the physical parts — wire upstream record outputs here, or list library document names/ids. A part is addressed by this NAME in the plan rows. |
| plan | string | yes | the plan, in DnaCauldron's spreadsheet shape: one line per construct, name,partA,partB. A construct name may itself be used as a part in a later line — that is what makes the plan multi-level. |
| method | string | no | the assembly chemistry every step uses (upstream passes one class per spreadsheet). Values: type2s (Golden Gate (Type-IIS)), gibson (Gibson / homologous), biobrick (BioBrick standard), basic (BASIC (l |
| include_subject | boolean | no | also offer the node's subject as a part. |
| _subject | object | 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. |
| _files | array | 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. |
DNA melting behaviour of the subject by the Poland–Scheraga model (DECIPHER): the melt curve (mean helicity vs temperature), its Tm50, and the cooperatively-melting domains behind each HRM peak.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| min_temp | number | no | lowest temperature to evaluate. In °C. |
| max_temp | number | no | highest temperature to evaluate. In °C. |
| step | number | no | grid spacing; finer costs proportionally more. In °C. |
| region_start | number | no | 0-based inclusive start of the region to melt. Unset = the whole sequence; pass the selection's start to scope to it. Advanced. |
| region_end | number | no | 0-based inclusive end. Unset = the whole sequence. Advanced. |
| ions | number | no | molar sodium-equivalent concentration. Defaults to DECIPHER's own 0.2 M; the editor substitutes the project's shared Na⁺ instead. In M. |
| _subject | object | 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. |
| _files | array | 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. |
Design an in-situ hybridization probe against the subject: tile it into candidate oligos that meet a melting-temperature, G+C and composition specification, screen them for off-target binding against an alignment and for k-mers abundant in a reference, and gather the survivors into the set that images best. Merges OligoMiner's tiling, its trained specificity model and its k-mer filter with iFISH's
| Parameter | Type | Required | Notes |
|---|---|---|---|
| min_length | number | no | shortest oligo to accept. In nt. |
| max_length | number | no | longest oligo to accept; the tiler grows a window until one fits, so a wide range yields more probes. In nt. |
| min_tm | number | no | lowest melting temperature to accept, AFTER the formamide correction. In °C. |
| max_tm | number | no | highest melting temperature to accept. In °C. |
| min_gc | number | no | lowest percent G+C to accept. In %. |
| max_gc | number | no | highest percent G+C to accept. In %. |
| sodium | number | no | monovalent cation concentration of the hybridization buffer. In mM. |
| formamide | number | no | formamide in the hybridization buffer; it lowers every melting temperature by about 0.65 °C per percent. In %. |
| dnac1 | number | no | concentration of the higher-concentration strand, typically the probe, in the melting-temperature calculation (OligoMiner --dnac1). In nM. |
| dnac2 | number | no | concentration of the lower-concentration strand, typically the target (OligoMiner --dnac2). The Tm uses dnac1 − dnac2/2, so equal values halve the effective concentration. In nM. |
| spacing | number | no | bases forced between consecutive oligos. In nt. Advanced. |
| prohibited | string | no | comma-separated subsequences an oligo may not contain; the default bans homopolymer runs, which hybridize promiscuously. Advanced. |
| overlap | boolean | no | report every window that qualifies, including overlapping ones. Off by default because overlapping oligos cannot be used together in one probe. Advanced. |
| origin | number | no | coordinate of the subject's first base, when it is a window cut from a larger sequence. Read from a UCSC-style range= header when the subject carries one. Advanced. |
| alignment_sam | string | no | SAM the candidates were aligned with, for off-target screening. Without it the oligos are returned UNSCREENED and the result says so. |
| screen_mode | string | no | trained model (recovers usable probes near repeats) · unique alignment only (strict) · no alignment at all (for a sequence that should be absent). Values: lda (Trained model), unique (Unique alignment |
| hybridization_temperature | number | no | temperature the specificity model was trained at. Only these six exist; the coefficients change sign across the range, so an intermediate value is a different model rather than a blend. In °C. Only ap |
| max_off_target_probability | number | no | keep an oligo whose modelled chance of a real off-target site is below this. Only applies when alignment_sam is set. Advanced. |
| kmer_reference | string | no | FASTA of the reference to count k-mers in, for OligoMiner's k-mer screen. Counted here, so a whole genome belongs in kmer_dump instead. Without either the oligos are returned with k-mer abundance UNCH |
| kmer_dump | string | no | jellyfish dump of a genome's k-mer dictionary, for a reference too large to count here: jellyfish count -m 18 -L 5 then jellyfish dump -c -L 5 keeps only the k-mers a screen at 5 acts on. Advanc |
Design padlock probes for in-situ sequencing against the subject: find the two-arm targets whose melting temperature falls in a window, check each against a BLAST search for any other transcript that could be ligated across the junction, pack non-overlapping targets from the 3' end, and assemble each into its padlock with the backbone given. Without BLAST results it returns the targets to search,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| arm_length | number | no | length of each target arm; the target is twice this. In nt. |
| interval | number | no | fewest bases between two packed targets. In nt. |
| min_tm | number | no | lowest target melting temperature to accept (exclusive), at 0.1 µM probe, 75 mM monovalent, 10 mM divalent salt and 20% formamide. In °C. |
| max_tm | number | no | highest target melting temperature to accept (exclusive). In °C. |
| blast_csv | string | no | blastn -outfmt 10 output for the targets FASTA this tool returns (run with -word_size 7 -strand plus against your transcriptome). Without it no target is checked for junction specificity. |
| variants | string | no | comma-separated accessions (no version) that count as the target itself, such as its isoforms. Empty: a hit counts as the target only when its accession is in the subject's name. Only applies when bla |
| linker_upstream | string | no | backbone sequence between the 3' arm and the barcode. Advanced. |
| barcode | string | no | the barcode read out by sequencing. Advanced. |
| linker_downstream | string | no | backbone sequence between the barcode and the 5' arm. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Design HCR v3.0 split-initiator probe pairs against the subject: tile its reverse complement into 52 nt windows, drop windows with C or G runs, a stable hairpin, G+C or RNA:DNA free energy outside their windows, or (given a bowtie2 alignment of the tiles) more than one genome hit, then pick non-overlapping tiles closest to the target free energy and split each around a 2 nt gap into an odd and an
| Parameter | Type | Required | Notes |
|---|---|---|---|
| channel | string | no | HCR amplifier whose split initiator the pair carries; one channel per target in a multiplexed experiment. |
| max_probes | number | no | most probe pairs to return. |
| tile_size | number | no | length of the target window each pair covers, both halves and the 2 nt gap. In nt. Advanced. |
| min_gc | number | no | lowest percent G+C of a tile. In %. |
| max_gc | number | no | highest percent G+C of a tile. In %. |
| min_gibbs | number | no | most stable RNA:DNA free energy to accept (at 37 °C, 0.33 M Na⁺). In kcal/mol. |
| max_gibbs | number | no | least stable RNA:DNA free energy to accept. In kcal/mol. |
| target_gibbs | number | no | free energy the selection ranks tiles by closeness to. In kcal/mol. |
| max_run_length | number | no | window length for the C and G run check. In nt. Advanced. |
| max_run_mismatches | number | no | bases in that window allowed to differ from the run base. In nt. Advanced. |
| max_hairpin_tm | number | no | drop a tile whose primer3 hairpin melts at or above this. In °C. Advanced. |
| dtm_filter | boolean | no | also require the two halves' melting temperatures to agree. Advanced. |
| dtm_max | number | no | largest allowed difference between the halves' melting temperatures. In °C. Only applies when dtm_filter is true. Advanced. |
| alignment_sam | string | no | SAM from bowtie2 -k 3 -f of the tiles FASTA this tool returns, against your genome or transcriptome. Without it no tile is checked for uniqueness and the result says so. |
| num_hits_allowed | number | no | most alignments a tile may have and still be kept (its own locus counts as one). Only applies when alignment_sam is set. |
| _subject | object | 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. |
| _files | array | 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. |
Design MERFISH encoding probes for the subject transcript: tile it into target regions, keep those whose G+C and melting temperature fall in their windows, that share no k-mer with an rRNA or tRNA, and whose k-mers occur in this gene's transcripts and nowhere else in the transcriptome; attach readout sequences that spell the gene's codeword, add the amplification primers, screen the whole oligo ag
| Parameter | Type | Required | Notes |
|---|---|---|---|
| transcriptome | string | no | every transcript of the organism as FASTA (RefSeq titles name the gene in their last parentheses); the subject is found in it by sequence. |
| target_id | string | no | the transcript to design for, by its FASTA id. Empty: the transcript whose sequence is the subject's. Advanced. |
| barcode | string | no | the gene's codeword, one 0 or 1 per bit, 1 where the bit is on. |
| readouts | string | no | the readout sequences as FASTA, one per bit, in bit order. |
| rtrna_reference | string | no | rRNA and tRNA sequences as FASTA. An Ensembl ncRNA FASTA is filtered to those biotypes by its headers. Empty: the rRNA/tRNA screen does not run. |
| expression | string | no | expression per transcript, one 'id value' line each (FPKM or TPM). Empty: every transcript weighs 1, MERFISH_probe_design's own choice without expression data. Advanced. |
| target_length | number | no | length of each target region. In nt. |
| min_gc | number | no | lowest G+C of a target region (exclusive). In %. |
| max_gc | number | no | highest G+C of a target region (exclusive). In %. |
| min_tm | number | no | lowest melting temperature of a target region (exclusive). In °C. |
| max_tm | number | no | highest melting temperature of a target region (exclusive). In °C. |
| sodium_mm | number | no | monovalent salt of the hybridization buffer. In mM. Advanced. |
| formamide | number | no | formamide in the hybridization buffer. In %. Advanced. |
| probe_nm | number | no | concentration of each probe. In nM. Advanced. |
| min_specificity | number | no | lowest specificity to keep (exclusive): the share of a region's k-mers found only in this gene. |
| specificity_k | number | no | k-mer length of the specificity and readout off-target counts. Advanced. |
| rtrna_k | number | no | k-mer length of the rRNA/tRNA screen. Advanced. |
| max_rtrna_ot | number | no | highest rRNA/tRNA off-target count to keep (exclusive); 0.5 keeps only regions with none. Advanced. |
| cross_talk_k | number | no | k-mer length of the library-wide cross-hybridization screen. Advanced. |
| readouts_per_probe | number | no | readout sequences carried by each probe, split between its two ends. |
Design Xenium custom-panel padlock targets on the subject transcript to 10x Genomics' published rules (CG000683): two 20 nt arms whose primer3 melting temperatures fall in their windows, a ligation-junction dinucleotide the Xenium ligase accepts, no run of five G in the probe, at least four mismatches across both arms to every other transcript in a BLAST search, and probes at least 10 bp apart. Wi
| Parameter | Type | Required | Notes |
|---|---|---|---|
| arm_length | number | no | length of each arm; the target is twice this. 10x's arms are 20 nt, shorter only for a short target whose Tm stays in range. In nt. Advanced. |
| tm_rule | string | no | which melting temperatures must fall in their windows. 10x: the full length between 68 and 82 °C or each arm between 50 and 70 °C. |
| min_full_tm | number | no | lowest Tm of the whole target (inclusive). In °C. |
| max_full_tm | number | no | highest Tm of the whole target (inclusive). In °C. |
| min_arm_tm | number | no | lowest Tm of each arm (inclusive). In °C. |
| max_arm_tm | number | no | highest Tm of each arm (inclusive). In °C. |
| junctions | string | no | ligation-junction dinucleotides to accept, from 10x's empirical ligase preferences; 10x strongly recommends avoiding the nonpreferred four. |
| max_g_run | number | no | longest run of G the probe may carry; 10x: avoid five or more. Advanced. |
| blast_csv | string | no | blastn -outfmt 10 output for the targets FASTA this tool returns, searched against the transcriptome (not the genome) with -word_size 7 -strand plus. Without it no target is checked for off-target hom |
| gene_accessions | string | no | comma-separated accessions (no version) that are this gene, its isoforms included: hits to them are not off-targets. Empty: the subject's name. Only applies when blast_csv is set. |
| min_mismatches | number | no | fewest mismatches across both arms an off-target hit must carry for the target to be kept; gaps and unaligned ends count. Only applies when blast_csv is set. |
| spacing | number | no | fewest bases between two kept targets. In bp. |
| probes_per_gene | number | no | targets to keep; 10x's predesigned panels use eight per gene. |
| prefer_cds | boolean | no | rank targets inside the subject's CDS feature before the untranslated regions, as 10x advises where possible. |
| _subject | object | 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. |
| _files | array | 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. |
Design a genetic circuit that computes: give it a logic function and it synthesizes a NOR/NOT netlist, assigns real characterized repressor gates from a Cello UCF library, predicts the dynamic range between ON and OFF, and emits the construct's DNA. The gate parameters are MEASURED, from the published libraries, with the host and growth conditions they were measured under reported alongside — neve
| Parameter | Type | Required | Notes |
|---|---|---|---|
| logic | string | no | the function the circuit computes: a named gate (NOT, AND, OR, NAND, NOR, XOR, XNOR, AND3, OR3, MAJORITY-3), or a truth table as one bit per input combination with the first input most significant (AN |
| library | string | no | the characterized gate library to build from. Each was measured in one host under one growth condition, and the prediction inherits both. |
| sensors | string | no | comma-separated input sensors the search may use. Leave unset to consider every sensor the library carries. Advanced. |
| reporters | string | no | comma-separated output reporters the search may use. Leave unset to consider all of them. Advanced. |
| groups | string | no | comma-separated repressor groups the search may draw on. Narrowing this is how a large search is made tractable — and how a gate you cannot obtain is kept out of the design. Advanced. |
| max_assignments | number | no | refuse rather than search past this many assignments. A ceiling, not a target: the search is EXHAUSTIVE, so it is never sampled — a best-of-some reported as a best-of-all is a wrong answer rather than |
| _subject | object | 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. |
| _files | array | 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. |
Self-similarity or pairwise comparison of the subject as a dot plot — repeats, inversions and shared regions. Three real engines: exact k-mer (FlexiDot/dottup), windowed identity (seqinr) and windowed substitution-matrix scoring (EMBOSS dotmatcher), which answer different questions.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| other | string | no | the sequence to compare against — wire a record or name a library document; leave unset for self-vs-self. |
| engine | string | no | exact k-mer (blind to diverged repeats) · windowed identity · matrix-scored windows (the only one that grades a substitution). Values: word (Exact k-mer (dottup)), window (Windowed identity (seqinr)), |
| word_size | number | no | k for the k-mer engine, or the window length for the other two. In bp. |
| reverse_complement | boolean | no | also plot matches against the reverse complement (k-mer engine). Only applies when engine is word. |
| best_path_only | boolean | no | reduce forward segments to a non-overlapping best path (EMBOSS dotpath). Only applies when engine is word. Advanced. |
| threshold | number | no | score a window must reach (EMBOSS default 23). Only applies when engine is matrix. Advanced. |
| nucleotide | boolean | no | nucleotide rather than protein. Advanced. |
| step | number | no | residues between window starts (seqinr wstep). 1 compares every position. Only applies when engine is window. Advanced. |
| min_matches | number | no | positions inside the window that must agree for it to be marked (seqinr nmatch). At 1 almost every window qualifies; raise it toward the window length to demand real identity. Only applies when engi |
| shift | number | no | phase offset applied to the second sequence's windows (seqinr shift). Only applies when engine is window. Advanced. |
| max_cells | number | no | refuse rather than compute past this many window comparisons. A ceiling, not a target: raise it for a large pair. Only applies when engine is window. Advanced. |
| matrix | string | no | which substitution matrix scores the windows. Unset picks EDNAFULL for nucleotide and EBLOSUM62 for protein, as EMBOSS dotmatcher does. Values: EDNAFULL (EDNAFULL (nucleotide)), EBLOSUM62 (EBLOSUM62 ( |
| matrix_text | string | no | a custom scoring matrix in EMBOSS/NCBI format, overriding matrix. Only applies when engine is matrix. Advanced. |
| dedupe | boolean | no | drop the duplicate runs dotmatcher's two passes leave on the shared diagonal. Off matches upstream; a caller that COUNTS runs wants it on. Only applies when engine is matrix. Advanced. |
| convert_wobbles | boolean | no | expand IUPAC ambiguity codes so a wobble matches what it stands for (FlexiDot). Only applies when engine is word. Advanced. |
| max_unknown_percent | number | no | percentage of a k-mer allowed to be N (or X for protein) before it is skipped. In %. Only applies when engine is word. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
All-against-all dot plot over a sequence SET — EMBOSS polydot. Every ordered pair is plotted with the exact k-mer engine and laid out as an N×N grid, so shared regions, repeats and inversions across a whole family are visible in one picture. Answers a different question from dot_plot, which compares exactly two: this one ranks which members share material and how much. Wire many upstream recor
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequences | array | yes | the set to compare all against all — wire several upstream outputs here, or list library document names/ids. |
| include_subject | boolean | no | also include the node's subject (the open or wired record) as a member of the set. |
| word_size | number | no | k. EMBOSS polydot's default is 6, which is smaller than dottup's because a grid of short panels needs a shorter word to show anything. In bp. |
| reverse_complement | boolean | no | plot each pair against the reverse complement too. Not an EMBOSS capability — ours, so an inversion between two members is visible. |
| best_path_only | boolean | no | reduce each panel's forward runs to a non-overlapping best path (EMBOSS dotpath). Advanced. |
| convert_wobbles | boolean | no | expand IUPAC ambiguity codes so a wobble matches what it stands for. Advanced. |
| max_unknown_percent | number | no | percentage of a k-mer allowed to be N (or X for protein) before it is skipped. In %. Advanced. |
| nucleotide | boolean | no | nucleotide rather than protein. Advanced. |
| gap | number | no | residues of blank space drawn between panels in the composite layout (EMBOSS default 10). Advanced. |
| max_sequences | number | no | refuse a set larger than this rather than starting N² comparisons. Advanced. |
| max_residues | number | no | refuse when the set's total residue count exceeds this. In bp. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Build a phylogeny from aligned sequences — distance methods (NJ, BIONJ, FastME, UPGMA/WPGMA), parsimony, maximum likelihood, or Bayesian MCMC under a strict clock and coalescent prior — with branch support from a bootstrap, aLRT or aBayes, or, for the Bayesian method, clade posterior probabilities. Wire it downstream of align_sequences.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequences | array | no | aligned sequences — wire align_sequences' rows here, or name library documents. |
| include_subject | boolean | no | also include the node's subject. |
| method | string | no | tree-building method; distance methods are fast, ML is the slowest and best-justified. Values: nj (Neighbor-Joining), bionj (BIONJ), fastme-bal (FastME (balanced)), fastme-ols (FastME (OLS)), upgma (U |
| model | string | no | distance/substitution model (ape's names). K80 is the engine's default; very divergent sequences need raw or JC69. |
| pairwise_deletion | boolean | no | exclude a gapped site only from the pairs it is missing in, rather than from every pair. ape's default is off (complete deletion), which keeps distances mutually comparable but discards a column if AN |
| gamma | number | no | gamma shape for among-site rate variation in the DISTANCE correction; 0 disables. Not the ML +Γ, which is ml_gamma_categories. Advanced. |
| support_method | string | no | which branch support to attach. bootstrap resamples alignment columns and rebuilds the tree per replicate (uses bootstrap/bootstrap_seed). The three branch tests re-infer nothing: they score eac |
| bootstrap | number | no | bootstrap replicates; 0 disables. Each replicate rebuilds the whole tree, so cost scales with it — 100 is the conventional minimum for a published tree and is the panel's default. Only applies when su |
| bootstrap_measure | string | no | which bootstrap statistic to report. fbp is Felsenstein's proportion: the share of replicates that carry this exact branch: a yes/no question per replicate, so one taxon landing elsewhere makes the |
| bootstrap_seed | number | no | seed for whichever resampling this run does — the bootstrap's replicates, or SH-aLRT's. The same seed always reproduces the same support values. Only applies when support_method is bootstrap or shalrt |
| sh_replicates | number | no | RELL replicates behind shalrt — resamples the three fits' per-site log-likelihoods, not the alignment, so a replicate costs microseconds rather than a whole re-inference. PhyML uses 10,000. Ignored |
| parsimony_rearrangement | string | no | parsimony topology search: nni hill-climbs by nearest-neighbour interchange, spr adds prune-and-regraft when NNI stalls (phangorn's own default), tbr adds bisect-and-reconnect when SPR stalls. N |
| fastme_nni | boolean | no | FastME refinement by nearest-neighbour interchange (ape's nni = TRUE). Only applies when method is fastme-bal or fastme-ols. Advanced. |
| fastme_spr | boolean | no | FastME balanced refinement by subtree prune-and-regraft (ape's spr = TRUE). Only applies when method is fastme-bal. Advanced. |
| ml_model | string | no | ML substitution model. Values: JC69 (JC69), F81 (F81), K80 (K80), HKY (HKY), TN93 (TN93), GTR (GTR). Only applies when method is ml, or when support_method is alrt or abayes or shalrt. Advanced. |
| ml_gamma_categories | number | no | discrete-Γ rate categories for the rate heterogeneity across sites; 1 disables it. Only applies when method is ml, or when support_method is alrt or abayes or shalrt. Advanced. |
| ml_shape | number | no | α of the discrete-Γ distribution over site rates — lower means more rate variation between sites. The starting value when the shape is estimated, and the fixed value when it is not. Inert while `ml_ga |
| ml_invariant | number | no | proportion of sites that never change; 0 disables. The starting value when it is estimated. Only applies when method is ml, or when support_method is alrt or abayes or shalrt. Advanced. |
| ml_optimise_topology | boolean | no | let the ML search move the topology. With this off the result is the Neighbor-Joining topology with ML branch lengths, and the engine says so in a warning. Only applies when method is ml. Advanced. |
| ml_rearrangement | string | no | topology search moves for the ML fit. nni moves one subtree past its neighbour and stops at the first topology no single move improves, which is a local optimum. spr runs that first and then sweep |
Choose the substitution model for a maximum-likelihood phylogeny by fitting every candidate — model x rate-heterogeneity x invariant-sites — on ONE shared topology and ranking them by AIC, AICc or BIC with Akaike weights. Fitting on a shared topology is the point: a model test that also searched topologies would vary two things at once, and a log-likelihood measured on a different tree answers a d
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequences | array | yes | aligned sequences — wire align_sequences' rows here, or name library documents. |
| include_subject | boolean | no | also include the node's subject. |
| models | array | no | candidate substitution models. Every one is fitted; the sweep costs one ML optimisation per candidate. |
| gamma_categories | array | no | discrete-Γ category counts to try. [1] is no rate heterogeneity; [1, 4] is the usual sweep and is the panel's default. |
| include_invariant | boolean | no | also try each model with a proportion of invariant sites (+I), doubling the candidate count. |
| criterion | string | no | which information criterion ranks the table. Changing it re-ranks candidates that are already fitted — it does not re-fit them. |
| _subject | object | 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. |
| _files | array | 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. |
Edit a tree that is already built — re-root it (at its midpoint, on an outgroup, or remove the root), prune taxa away or down to a set, ladderize it, or collapse branches that are too weakly supported or too short to believe. Pruning the TREE keeps the branch lengths estimated from the full alignment, which is a different answer from rebuilding without those taxa.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| newick | string | yes | the tree to edit — wire newick from build_tree, or paste one. |
| operation | string | no | what to do to the tree. Values: reroot-midpoint (Re-root at the midpoint), reroot-outgroup (Re-root on an outgroup), unroot (Remove the root (unroot)), prune-keep (Prune down to these taxa), prune-rem |
| taxa | array | no | tip labels — the outgroup for a re-root, or the taxa to keep/remove for a prune. Only applies when operation is reroot-outgroup or prune-keep or prune-remove. |
| position | number | no | where along the outgroup edge the root lands, 0 = at the outgroup, 1 = at its sister. Only applies when operation is reroot-outgroup. Advanced. |
| min_support | number | no | contract any branch whose support is below this (0 = do not). Only applies when operation is collapse. |
| max_length | number | no | collapse any branch shorter than this (0 = do not). Only applies when operation is collapse. |
| ascending | boolean | no | ladderize small clades first, rather than large. Only applies when operation is ladderize. |
| _subject | object | 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. |
| _files | array | 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. |
Draw a tree as an SVG figure — rectangular, slanted, circular or unrooted, as a phylogram or a cladogram, with tip names, branch support and a scale bar. The same layout the phylogeny panel draws with, so the figure and the panel place every node identically. Wire newick from build_tree or edit_tree.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| newick | string | yes | the tree to draw — wire newick from build_tree, or paste one. |
| layout | string | no | drawing style; unrooted is the only honest one for a tree whose method inferred no root, because a rectangular drawing of it implies a root that was never inferred. Values: rectangular (Rectangular) |
| width | number | no | figure width. In px. |
| height | number | no | figure height. In px. |
| branch_lengths | boolean | no | phylogram: horizontal distance IS evolutionary distance. Off draws a cladogram, which shows the topology alone — and then no scale bar is drawn, because the drawing is not to scale. |
| tip_labels | boolean | no | print each tip's name, reserving the gutter they need. |
| support | boolean | no | print each internal branch's support value where it carries one. |
| min_support | number | no | below this, a support value is not printed. Only applies when support is true. Advanced. |
| font_size | number | no | tip-label size. In px. Advanced. |
| unrooted_method | string | no | which unrooted algorithm places the nodes; equal daylight only rotates subtrees about their nodes, so it preserves every branch length. Only applies when layout is unrooted. Advanced. |
| length_unit | string | no | what the branch lengths MEAN, for the scale bar's caption. A tree read from a file carries no unit, so say what it is rather than letting the bar claim substitutions/site. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Compare trees over the same taxa: the Robinson-Foulds distance between two of them, and the consensus of any number. Two methods disagreeing is a result about the data, so the distance and the shared topology are reported together.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| trees | array | yes | two or more trees in Newick (NEXUS, PhyloXML and NeXML pastes are sniffed too) — wire newick outputs here. |
| mode | string | no | how strict the consensus is: strict keeps only clades in EVERY tree; majority keeps those above the cutoff. Values: majority (Majority-rule), strict (Strict). |
| cutoff | number | no | the fraction of trees a clade must appear in for a majority consensus. Only applies when mode is majority. |
| sharedTaxaOnly | boolean | no | prune every tree to the taxa they ALL share before comparing, instead of refusing a mismatch. The numbers then describe the pruned trees, and pruning can only remove or merge splits, so the distance i |
| _subject | object | 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. |
| _files | array | 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. |
Describe a tree without rebuilding it: its shape statistics (tips, height, balance, the gamma statistic), the lineages-through-time curve, and the patristic distance matrix — the path lengths through the tree, which is what to compare against the alignment distances that built it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| newick | string | yes | the tree to describe — wire newick from build_tree, or paste one. |
| _subject | object | 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. |
| _files | array | 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. |
Read what a NeXML tree file says about each of its taxa: every annotation on every OTU (an NCBI taxon, a rank, a parent taxon), one row per annotation, plus how many distinct values each property takes. This is the tip data the phylogeny canvas draws as a strip beside the tips, where a value that recurs further down is a group the tree does not keep together.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| nexml | string | yes | a NeXML document (the text of a .xml tree file). |
| _subject | object | 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. |
| _files | array | 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. |
Convert a tree between the four formats this workbench reads and writes — Newick, NEXUS, PhyloXML and NeXML — sniffing the input format rather than making the caller declare it. Newick loses annotations the richer formats carry, which is why the conversion is a step you choose rather than something done silently on export.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| tree | string | yes | the tree, in any of the four formats. |
| format | string | no | the format to write. Values: newick (Newick), nexus (NEXUS), phyloxml (PhyloXML), nexml (NeXML). |
| name | string | no | the tree's name inside the written file (NEXUS and NeXML carry one). Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Check an index set you ALREADY have, rather than designing a new one: the minimum distance between any two, how many errors that guarantees correcting, the full distance matrices, and — optionally — the subset that survives pruning to a stricter error budget. This is the question asked of a set inherited from a kit or a previous experiment.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| barcodes | array | yes | the index sequences to audit. |
| metric | string | no | error model to audit against — a set safe under substitutions may be unsafe under indels. Values: hamming (Hamming (substitutions)), seqlev (Sequence-Levenshtein (indels)), levenshtein (Levenshtein). |
| required_distance | number | no | the minimum distance the set is supposed to have — the audit says whether it does. |
| prune_to_errors | number | no | also report the subset that would survive pruning to a free code correcting this many errors. 0 = do not prune. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Assign reads to the index each one came from, and say how many could NOT be assigned reliably — a hit further from a barcode than the set's guaranteed correction radius is not that barcode, and counting it as one is how a demultiplexing report hides a failed run.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| barcodes | array | yes | the index set the reads were tagged with. |
| reads | array | yes | the observed index reads to assign. |
| metric | string | no | must match the error model the set was designed under. Values: hamming (Hamming (substitutions)), seqlev (Sequence-Levenshtein (indels)), levenshtein (Levenshtein). |
| _subject | object | 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. |
| _files | array | 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. |
Write an index set out in the form the next step needs: a CSV or TSV order sheet, FASTA, an IDT bulk-input sheet of the bare tags, an Illumina BCLConvert SampleSheet, or the actual oligos — adapters built on a template, or primers carrying the tag — with the junction warnings that emission produces.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| barcodes | array | yes | the index sequences to write out. |
| format | string | no | what to write. Values: csv (CSV order sheet), tsv (TSV), fasta (FASTA), idt (IDT bulk input), samplesheet (Illumina SampleSheet), adapters (Adapter oligos), primers (Tagged primers). |
| prefix | string | no | name prefix for the rows (BC001, BC002 …). |
| idt_scale | string | no | IDT synthesis scale, exactly as IDT writes it (e.g. 25nm, 100nm, 250nm). Asked for rather than defaulted: which options exist depends on oligo length. Only applies when format is idt. |
| idt_purification | string | no | IDT purification (e.g. STD, PAGE, HPLC). Check what your scale allows before ordering. Only applies when format is idt. |
| primer | string | no | the primer the tag is added to. Only applies when format is primers. |
| adapter_5 | string | no | sequence 5' of the tag in the adapter — the Illumina P5, as the panel offers. Only applies when format is adapters. |
| adapter_3 | string | no | sequence 3' of the tag in the adapter — the TruSeq read-1 primer, as the panel offers. Only applies when format is adapters. |
| _subject | object | 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. |
| _files | array | 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. |
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).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| length | number | no | barcode length in bases. In bp. |
| min_distance | number | no | required minimum distance between any two barcodes — this is what buys the error correction. |
| metric | string | 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 (ind |
| heuristic | string | no | set-construction strategy. Values: conway (Conway (greedy)), clique (Clique), sampling (Sampling), ashlock (Ashlock). |
| filter_triplets | boolean | no | reject barcodes containing a homotriplet (AAA…). Advanced. |
| filter_gc | boolean | no | keep only balanced-GC barcodes (suppressed for length ≤ 3). Advanced. |
| filter_self_complementary | boolean | no | reject barcodes that are their own reverse complement. Advanced. |
| seed | number | no | PRNG seed for a stochastic search: the same seed always gives the same set. Only applies when heuristic is sampling or ashlock. |
| iterations | number | no | random restarts of the Conway closure (sampling) or generations of the evolutionary search (ashlock); DNABarcodes' default. Only applies when heuristic is sampling or ashlock. |
| population | number | no | chromosomes carried per Ashlock generation; DNABarcodes' default. Only applies when heuristic is ashlock. |
| _subject | object | 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. |
| _files | array | 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. |
Design qPCR assays over the subject — primer pair plus hydrolysis probe, ranked by penalty, with amplicon size/GC, per-oligo Tm and whether both primers bind a single site.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| region_start | number | no | 0-based inclusive start of the region to design in. Unset = the whole sequence; pass the selection's start to scope to it. Advanced. |
| region_end | number | no | 0-based inclusive end. Unset = the whole sequence. Advanced. |
| max_results | number | no | how many assays to return, best penalty first. |
| conditions | object | no | salt, magnesium, dNTP and oligo concentrations plus the salt-correction method and any DMSO or formamide that every Tm in this design is measured in. Left unset it is filled from your reaction-conditi |
| structure_check | boolean | no | run the thal secondary-structure check on the RETURNED assays: hairpin and cross-dimer melting temperatures for all three oligos and every pairing between them. On by default, because a qPCR assay t |
| probe_chemistry | string | no | what the hydrolysis probe is made of. dna is unmodified DNA; lna locks the bases named by probe_locked_positions, which raises the probe Tm and is how a short probe reaches the TaqMan offset ove |
| probe_locked_positions | string | no | which bases to lock, 1-based from the probe's 5′ end, e.g. 3, 6, 9. Read only when probe_chemistry is lna. Positions must be interior to the SHORTEST probe the search will try and never adjacent |
| amplicon_min | number | no | shortest acceptable amplicon. In bp. |
| amplicon_max | number | no | longest acceptable amplicon - qPCR amplicons are short on purpose, because a short product amplifies efficiently enough for the exponential phase to be clean. In bp. |
| primer_tm_opt | number | no | target primer Tm; the penalty ranks candidates by their distance from it. In °C. |
| probe_tm_opt | number | no | target probe Tm - conventionally ~10 °C above the primers, so the probe is bound before extension reaches it. In °C. |
| probe_tm_offset_min | number | no | how many °C the probe Tm must exceed the MEAN primer Tm. TaqMan guidance is 8-10; below that the probe can melt off before it is cleaved. In °C. |
| primer_min_length | number | no | shortest primer considered. In nt. Advanced. |
| primer_opt_length | number | no | primer length the penalty prefers. In nt. Advanced. |
| primer_max_length | number | no | longest primer considered; primer3's own ceiling is 36. In nt. Advanced. |
| primer_min_tm | number | no | primers below this Tm are rejected outright, not merely penalised. In °C. Advanced. |
| primer_max_tm | number | no | primers above this Tm are rejected outright. In °C. Advanced. |
| primer_min_gc | number | no | lowest acceptable primer GC content. In %. Advanced. |
| primer_max_gc | number | no | highest acceptable primer GC content. In %. Advanced. |
| probe_min_length | number | no | shortest probe considered. In nt. Advanced. |
A Scorpion probe's two melting temperatures, side by side: the stem-loop's own hairpin and the duplex the loop makes with its target on the amplicon. A Scorpion is a primer carrying a stem-loop probe on a non-amplifiable blocker (Whitcombe 1999), and it reports by the loop finding its target and pulling the stem apart - so the design question is a RELATION between those two structures, not a prope
| Parameter | Type | Required | Notes |
|---|---|---|---|
| probe | string | yes | the whole probe element, 5' stem arm + loop + 3' stem arm. The element is what folds, so it is what the structure engine is given - the loop alone would compute a hairpin the molecule does not have. |
| target | string | yes | the loop's target on the amplicon, 5'->3'. This is the OTHER temperature: a Scorpion opens because the loop finds this, so it is the loop-target duplex that has to be stable, not the loop's own self-s |
| stem_length | number | no | how many bases of the 5' end form the stem arm. Reported back rather than guessed. The two vendors disagree on the range - LGC Biosearch, who sell Scorpions, publish 5-7 nt and PremierBiosoft's design |
| margin | number | no | how many °C the stem Tm must exceed the loop-target Tm for the verdict to pass. Yours to set: the 5-10 °C rule of thumb this defaults to the floor of is a design tool's, not a measured value from the |
| conditions | object | no | salt, magnesium, dNTP and oligo concentrations plus the salt-correction method the stem Tm is measured in. Left unset it is filled from your reaction-conditions settings, and falls back to primer3's d |
| _subject | object | 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. |
| _files | array | 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. |
Predict the amplification curve a hydrolysis-probe (TaqMan) qPCR assay will draw, and the Cq read off it, from the assay's own sequences and its thermocycling programme - a forward simulation, not a fit to data. Ports DYNAMIC (Kreitmann et al., Anal. Chem. 2026, 98(12):9089-9101): thirteen species, four phases per cycle, mass-action annealing integrated as a stiff ODE, with primer-dimer formation
| Parameter | Type | Required | Notes |
|---|---|---|---|
| amplicon | string | yes | the amplicon, forward strand, 5'->3'. The whole product, not the region between the primers: the amplicon's own re-annealing is a species in the model and it competes with the primers for template lat |
| forward_primer | string | yes | forward primer, 5'->3'. |
| reverse_primer | string | yes | reverse primer, 5'->3'. |
| probe | string | yes | the hydrolysis probe, 5'->3'. Fluorescence in this model IS probe cleavage, so without a probe there is no curve to predict - this is a TaqMan simulator and not a SYBR one. |
| primer_dimer_dg | number | no | free energy of the forward-reverse primer dimer, kcal/mol, negative. NOT computed for you, and that is deliberate: the paper computes it with NUPACK and says why nothing simpler does - 'the nonspecifi |
| template_copies | number | no | template copies in the reaction at cycle 0. This is the quantity Cq is a readout OF, so sweeping it is how you get a standard curve out of this node. In copies. |
| forward_primer_molar | number | no | forward primer concentration, mol/L (450 nM in upstream's assay). In M. Advanced. |
| reverse_primer_molar | number | no | reverse primer concentration, mol/L (460 nM in upstream's assay). In M. Advanced. |
| probe_molar | number | no | probe concentration, mol/L (150 nM in upstream's assay). It caps the plateau: fluorescence cannot exceed the probe you put in. In M. Advanced. |
| cycles | number | no | how many cycles to run. In cycles. |
| annealing_temperature | number | no | annealing temperature, °C. Every binding constant in the model is evaluated here, so this is the single knob that moves the whole curve rather than scaling it. In °C. |
| annealing_time | number | no | seconds at the annealing temperature. A real parameter of the answer, not a formality: the system is NOT at equilibrium when a 15 s anneal ends, so a longer hold binds measurably more. In s. |
| denaturation_time | number | no | seconds at the denaturation temperature. It reaches the answer only through polymerase decay, so with k_deg at 0 it changes nothing. In s. Advanced. |
| k_deg | number | no | polymerase thermal-decay rate constant. Upstream SHIPS this at 0 - no decay, efficiency identically 1 at every cycle - with its own code commenting 'original value: 1.9e-4'. Left at 0 you are running |
| beta | number | no | stretching exponent of the decay, exp(-(k_deg*t)^beta). Upstream ships 1, which makes the decay a plain exponential. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Amplification curves to Cq, one row per reaction. Fits each raw fluorescence curve to a sigmoid (l4-l7, b4-b7), reads the Cq off it under any of the seven definitions (cpD1, cpD2, maxE, expR, Cy0, CQ, maxRatio) or at a fluorescence threshold you set (the classic Ct), and returns the per-reaction efficiency and the fit-quality block beside it, so a bad fit is visible next to the Cq it produced rath
| Parameter | Type | Required | Notes |
|---|---|---|---|
| curves | string | yes | the amplification table: a header row, first column the cycle number and every other column one reaction's fluorescence. Tab- or comma-separated, and read by the same parser the Curve->Cq tab uses. |
| model | string | no | which sigmoid is fitted before a Cq is read off it. Ignored when auto_model is on, except as the starting point mselect ranks from. Values: l4 (l4 · 4-param log-logistic), l5 (l5 · + asymmetry), l6 |
| cq_method | string | no | which Cq definition. These are genuinely different quantities, not one number under several names. Values: cpD2 (cpD2 · second-derivative max), cpD1 (cpD1 · first-derivative max), maxE (maxE · cycle o |
| auto_model | boolean | no | let the plate choose its own model. mselect runs on the FIRST reaction and its winner is applied to every reaction, because Cqs fitted under different models are not comparable — the result reports wh |
| criterion | string | no | how auto_model ranks. The nested tests are only meaningful inside one family (l4-l7 or b4-b7); AICc weights is the one that can rank all eight. The reduced chi-square needs a measurement error per cyc |
| outlier_method | string | no | which kinetic-outlier test judges the reaction shapes. Two are univariate and three judge a curve's whole shape against a robust MCD covariance of the plate, so a plate can look clean under one and di |
| baseline_from | number | no | first cycle of the window the sliwin and LRE estimators scan a baseline over. Affects the all-methods table only: the sigmoidal fit and its Cq do not use a baseline scan. In cycle. Advanced. |
| baseline_to | number | no | last cycle of that window. In cycle. Advanced. |
| baseline_scan | number | no | how many SDs of offset the baseline scan searches; 0 subtracts nothing, which is upstream's own default and is WRONG on real instrument data. Measured against the real LinRegPCR over the 47 reactions |
| shift | number | no | cycles added to every reported Cq, for aligning against an instrument's own numbering. Advanced. |
| threshold | number | no | a fluorescence threshold, on the plate's own fluorescence scale. Set, every Cq is the cycle where the fitted curve crosses it (the classic threshold cycle, Ct) and cq_method is overridden. Blank rea |
| amounts | string | no | the known template amount of each reaction, in column order (comma- or space-separated, - for a reaction with none). Each reaction given one reports its calibration factor cf, the amount over `ini |
| max_ratio_baseshift | number | no | fluorescence added to every cycle before the maxRatio spline is drawn. qpcR's own remedy when a baseline near zero makes the cycle-to-cycle ratio explode; it moves only the maxRatio Cq. Only applies |
| max_ratio_smooth | boolean | no | smooth the raw curve before the maxRatio spline is drawn, as qpcR's eff(smooth = TRUE) does. Moves only the maxRatio Cq. Only applies when cq_method is maxRatio. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Relative gene expression from a Ct table, by all THREE models the Analyze panel offers: delta-delta-Ct (normalised to a reference gene AND calibrated to a reference group), delta-Ct (calibrated to a reference group only), and the two-step standard-curve model, which fits each gene's own dilution series and converts Ct to amount before taking the ratio. Reproduces the pcr package's pcr_ddct/`pc
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ct_table | string | yes | the Ct table: a header row of gene names, then one row per sample. Tab- or comma-separated, the same table the Analyze tab takes. |
| groups | string | yes | the group each sample belongs to, one per line, in the same order as the Ct rows (e.g. six lines of control then six of treated). |
| reference_gene | string | no | the gene expression is normalised to. Required for delta-delta-Ct and for the standard-curve model; ignored by delta-Ct, which normalises to a group only. Only applies when model is delta_delta_ct or |
| reference_group | string | yes | the group everything is calibrated against: the untreated / time-zero / wild-type arm. |
| model | string | no | which model. delta_delta_ct and relative_curve need a reference gene, delta_ct does not; relative_curve additionally needs standard_ct_table and amounts, because it fits a real dilution se |
| tube | string | no | separate_tube: target and reference amplified in different wells, errors independent. same_tube: multiplexed in one well, subtracted per well before averaging. Advanced. |
| standard_ct_table | string | no | the SERIAL-DILUTION Ct table the standard curve is fitted to - a second plate, not the sample one. Required by relative_curve, and by assess_efficiency on any model. Advanced. |
| amounts | string | no | the input amount of each dilution row, one per row of standard_ct_table, whitespace- or comma-separated. The fit is against log10 of these, so every value must be positive. Advanced. |
| assess_efficiency | boolean | no | run pcr_assess(method = 'efficiency') beside delta-delta-Ct: delta-Ct against the reference gene regressed on log10 amount, per gene. This is how the model's equal-efficiency assumption is CHECKED r |
| sig_test | string | no | which significance test runs beside the model. t.test is Welch's two-sample test on the normalised values; lm is the equivalent linear model, which reports the same p with a confidence interval; ` |
| wilcox_alternative | string | no | the Wilcoxon alternative hypothesis. Values: two.sided (Two-sided), less (Less (shift < 0)), greater (Greater (shift > 0)). Only applies when sig_test is wilcox.test. Advanced. |
| wilcox_exact | string | no | which Wilcoxon null distribution. auto applies R's own rule (exact while both groups are under 50 and there are no ties); exact forces the exact distribution, which is costly on large groups; `nor |
| wilcox_correct | string | no | tail refinement for the Wilcoxon normal approximation: none, R's continuity correction, or 1-3 Edgeworth terms. Ignored when the exact distribution is used. Values: none (None), continuity (Contin |
| wilcox_conf_level | number | no | confidence level for the Wilcoxon location-shift interval. Only applies when sig_test is wilcox.test. Advanced. |
| lm_formula | string | no | the design formula for lm.design, in R's own notation (~ group, ~ group + dose, ~ group * run). group is always available from groups with no paste at all. Only applies when sig_test is lm |
| lm_variables | string | no | extra design variables for lm.design: a header row of variable names, then one row per sample in the Ct table's order. A column whose every value parses as a number is a covariate, otherwise a facto |
| lm_mode | string | no | how lm.design normalises the target against the reference gene before fitting: subtract the reference Ct (the delta-Ct scale), or divide by it. Values: subtract (Subtract (ΔCt = target − referen |
| lm_conf_level | number | no | confidence level for the lm.design coefficient intervals. Only applies when sig_test is lm.design. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Which candidate reference gene is actually stable, ranked by all four published algorithms at once plus the RefFinder consensus: geNorm (pairwise variation M), NormFinder (intra/inter-group variance), BestKeeper (SD of raw Cq and correlation to the index) and the comparative delta-Ct method. They disagree on real plates, which is the point of running them side by side; the consensus is the geometr
| Parameter | Type | Required | Notes |
|---|---|---|---|
| cq_table | string | yes | the long-format table: Target,Sample,Cq, one row per measurement. A fourth Group column is optional and is what unlocks NormFinder's GROUPED arm; without it NormFinder answers a different question |
| normfinder_arm | string | no | which NormFinder to run. auto uses the grouped model when the table has a Group column and the ungrouped one when it does not; ungrouped forces the variance-only estimate even on a grouped table. |
| _subject | object | 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. |
| _files | array | 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. |
Read an instrument's RDML export - the open qPCR exchange standard, v1.0 to v1.4 - and hand back one run's contents as the same tables every other qPCR tool here takes. This is the step every qPCR analysis starts from. Lists what each run actually holds (amplification curves, melting curves, instrument Cq values, digital-PCR partition counts with the partition volume the file declares) before anyt
| Parameter | Type | Required | Notes |
|---|---|---|---|
| rdml_xml | string | yes | the RDML document as XML text - the rdml_data.xml member of a .rdml archive, or a bare .xml export. Not base64 and not a file path. |
| run | number | no | which run to read, 0-based across every experiment in the file in document order. A file routinely holds several; summary lists them all whatever this is set to. |
| table | string | no | which table to return for the chosen run. summary reads the file without importing anything. The other four are exactly what the panel's four Send to ... buttons produce, so a value imported here |
| _subject | object | 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. |
| _files | array | 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. |
Digital PCR (dPCR) partition counts to absolute concentration, with no standard curve. Positives and accepted partitions become lambda = -ln(1 - k/n), lambda becomes copies per uL through the partition volume and the dilution chain, and the confidence interval is carried on the lambda scale under any of eleven published binomial interval methods. Returns the dMIQE-2020 occupancy QC beside every re
| Parameter | Type | Required | Notes |
|---|---|---|---|
| wells | string | yes | the well table: Well,Sample,Target,Positives,Partitions. Instrument column names are accepted as they are printed (Bio-Rad's AcceptedDroplets, QIAcuity's Valid partitions), so a real export need |
| partition_volume_nl | number | no | mean volume of ONE partition. A per-platform constant, not a universal one (Bio-Rad QX200 approx 0.85 nL, QIAcuity 26k approx 0.34 nL, QuantStudio 3D approx 0.755 nL), and dMIQE 2020 requires it to be |
| reaction_volume_ul | number | no | total reaction volume, for copies per reaction. In uL. |
| template_volume_ul | number | no | volume of template added to the reaction. Left at 0 the sample-concentration row is omitted rather than guessed. In uL. Advanced. |
| dilution_factor | number | no | fold dilution applied to the sample before the reaction (2 = diluted 1:2). Advanced. |
| ci_method | string | no | which binomial confidence interval is carried onto the lambda scale. Values: agresti-coull (Agresti–Coull), asymptotic (Asymptotic (normal approximation)), bayes (Bayes (Jeffreys prior, highest-densit |
| conf_level | number | no | confidence level for the interval. Advanced. |
| merge_replicates | boolean | no | pool wells that share a sample and target before quantifying. Replicates of one measurement are one measurement, and pooling the COUNTS is the correct way to combine them, never averaging concentratio |
| ratio_target | string | no | the assay whose COPY NUMBER you want, named as it appears in the table's Target column. Leave it and ratio_reference unset and no copy number is reported at all — a guessed pair is a fabricated comp |
| ratio_reference | string | no | the assay it is measured against: the single-copy or known-ploidy reference, again by its Target name. |
| reference_copies | number | no | copies of the REFERENCE target per genome. 2 is a diploid autosome, 1 a haploid or single-copy locus. Advanced. |
| volume_model | string | no | how partition-volume SPREAD is handled (QP-5c). poisson is the standard estimator and assumes every partition holds the same volume. The two Poisson-Plus arms (Majumdar 2017) integrate the Poisson n |
| volume_cv | number | no | coefficient of variation of the partition volume, as a percentage. Ignored under the poisson model. There is no universal value and inventing one would fabricate the exact quantity the correction co |
| _subject | object | 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. |
| _files | array | 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. |
Two-channel ddPCR droplet-amplitude exports to a template concentration, by CLASSIFYING the raw droplets rather than trusting a count the instrument already made. Four steps in a fixed order, each of which needs the previous one's output: a k-means quality check marks wells whose two droplet clusters are not separable, a plate-wide 1%-slice IQR cutoff marks outlier droplets, a two-component Gaussi
| Parameter | Type | Required | Notes |
|---|---|---|---|
| files | string | yes | the droplet exports, as <filename> and its CSV body. QuantaSoft writes one <name>_<well>_Amplitude.csv per well with columns Assay1 Amplitude, Assay2 Amplitude, Cluster; the well id is read from |
| random_seed | number | no | re-seeded before EVERY k-means and EVERY mixture fit, not once per run. Neither has a deterministic start, so this value IS part of the answer: a different seed lands the mixture on a different local |
| droplet_volume_ul | number | no | mean volume of ONE droplet, in µL. A per-platform constant: 0.85e-3 µL (0.85 nL) for the Bio-Rad QX200, which is what the QuantaSoft export comes from. |
| total_drops_t | number | no | fewer accepted droplets than this and the well is rejected before it is clustered at all. |
| empty_lambda_low | number | no | smallest empty-droplet fraction a well may have. Below it the smaller k-means cluster is too small to be the empty population, which means the run did not separate. |
| empty_lambda_high | number | no | largest empty-droplet fraction a well may have. Above it almost every droplet is empty, so there is no positive population to quantify and a concentration would be an extrapolation. |
| top_percent | number | no | the top slice of droplets, pooled across the SUCCESSFUL wells, that the outlier cutoff is computed on. One cutoff per axis for the whole plate, not one per well. |
| cutoff_iqr | number | no | how many interquartile ranges above the third quartile of that slice a droplet must sit to be an outlier. |
| cutoff_sd | number | no | how many standard deviations above the LOWER mixture component's mean the empty cutoff sits. This is the knob that decides which droplets are empty, and therefore the concentration. |
| x_var | string | no | name for the X channel, which is the file's SECOND amplitude column. Bio-Rad's Ch2 is usually HEX or VIC. |
| y_var | string | no | name for the Y channel, which is the file's FIRST amplitude column. Bio-Rad's Ch1 is usually FAM. |
| _subject | object | 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. |
| _files | array | 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. |
ddPCR droplet amplitudes to populations. For TWO targets, a four-way classification — NN, NP, PN, PP — under any of THREE published methods that answer different questions and none of which is a fallback for another. grid applies eight fixed thresholds: reproducible and auditable, the only one that does not move when the data does, and the only one that needs someone to have chosen the numbers.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| droplets | string | yes | the well to classify: two amplitude columns, Ch1 then Ch2, one row per droplet. A header line is optional. This is the whole well, not a summary. For the ddPCRclust methods it may instead be a PLA |
| method | string | no | which classifier. grid needs its eight thresholds to suit your assay; kmeans needs nothing and cannot abstain; knn needs training and is the only one that can leave a droplet unassigned; `dens |
| markers | string | no | for density: the well's four marker slots, comma-separated, as in ddPCRclust's run template. A name is a target the reaction carries; an EMPTY slot is one it does not, so a,,c,d is a three-target |
| sensitivity | number | no | for density: how finely the initial cluster search resolves density peaks (its step is 0.02 / sensitivity³). Higher divides the data into more clusters, lower merges more. Only applies when method i |
| distance_param | number | no | for density: the share of the path between two clusters within which rain goes to the LOWER one; the rest goes to the higher one. Only applies when method is density or samspectral or flowpeaks or e |
| sam_seed | number | no | for samspectral and ensemble: R's set.seed before the run. SamSPECTRAL keeps the best of 1000 k-means starts drawn from it, and on a plate one stream runs through the wells in order, as `ddPCRcl |
| template | string | no | for a PLATE under the ddPCRclust methods: ddPCRclust's run template (a >name, channel1=..., channel2=..., description line, then Well,Sample type,# of markers,Marker 1..Marker 4). Each well then t |
| constant_control | string | no | for a PLATE under the ddPCRclust methods: the marker that should read the same in every well. Every well's copies per droplet are multiplied by the control's highest value on the plate over its own, a |
| training | string | no | for knn only: an already-labelled well, as Ch1,Ch2,class with class one of NN, NP, PN, PP or Rain. Rain IS a class here and not a rejection — a droplet can be assigned to it on the strength of its |
| k | number | no | for knn: how many nearest labelled neighbours vote. Only applies when method is knn. |
| prob | number | no | for knn: the smallest winning share of the vote that counts as a call. Below it the droplet is Rain. 0 disables the floor. At k = 5 a bare 3-2 majority is 0.6, so any floor at or below 0.5 accepts |
| ch1_nn | number | no | grid: Ch1 below this and Ch2 below ch2_nn is NN. Only applies when method is grid. |
| ch2_nn | number | no | grid: the Ch2 half of the NN box. Only applies when method is grid. |
| ch1_np | number | no | grid: Ch1 below this and Ch2 above ch2_np is NP. Only applies when method is grid. |
| ch2_np | number | no | grid: the Ch2 half of the NP box. Only applies when method is grid. |
| ch1_pn | number | no | grid: Ch1 above this and Ch2 below ch2_pn is PN. Only applies when method is grid. |
| ch2_pn | number | no | grid: the Ch2 half of the PN box. Only applies when method is grid. |
| ch1_pp | number | no | grid: Ch1 above this and Ch2 above ch2_pp is PP. Only applies when method is grid. |
| ch2_pp | number | no | grid: the Ch2 half of the PP box. Only applies when method is grid. |
| random_seed | number | no | for knn: ties among equidistant neighbours, and among tied winning classes, are broken from this stream. On a well-separated plate it changes nothing; where droplets sit exactly between populations |
Melt curves to melting temperature, under any of THREE engines that answer different questions and none of which is a fallback for another. plate (RDML-Python) normalises, derives twice, calls the peaks of -dF/dT and CLASSIFIES them against the target's expected Tm into per-reaction verdicts — one peak in the window is the product, an extra peak is an artifact or a primer dimer, no peak at all i
| Parameter | Type | Required | Notes |
|---|---|---|---|
| melt_table | string | yes | the melt table: a header row, first column the temperature and every other column one reaction's fluorescence. The same table the Melt tab takes. |
| engine | string | no | which of the three engines runs. They answer DIFFERENT questions: plate is the only one that produces a verdict, vertex the only one whose Tm is not a sampled temperature, curve the only one tha |
| expected_tm | number | no | the product's expected melting temperature, which is what turns a peak list into a verdict. Left unset, every peak is reported and none is classified - an honest absence rather than a guess. Read by t |
| extremum | string | no | vertex only: which extremum the melt sits at. auto reads each curve's direction, because upstream assumes a signal that RISES with temperature and a solution-phase melt FALLS — on which the defaul |
| window_ceiling | number | no | vertex only: the largest neighbourhood half-width the quadratic is tried at. Every width from 2 up to this is fitted and the one with the best adjusted R-squared wins, so the Tm arrives with the fit |
| second_derivative | boolean | no | vertex only: locate the inflection points of the melt (diffQ2) rather than the peak of the first derivative. Only applies when engine is vertex. Advanced. |
| all_peaks | boolean | no | vertex only: report every peak the curve carries, not the dominant one alone. Only applies when engine is vertex. Advanced. |
| resample | boolean | no | vertex only: resample the curve onto an even temperature grid before differentiating. Only applies when engine is vertex. Advanced. |
| span_smooth | number | no | curve only: the smoothing span of the cubic spline fitted before the analytic derivative. Only applies when engine is curve. Advanced. |
| span_peaks | number | no | curve only: the span Friedman's super smoother uses when the peaks are called. Only applies when engine is curve. Advanced. |
| cut_area | number | no | curve only: drop peaks whose area is under this fraction of the largest. 0 keeps every peak, which is upstream's own default. Only applies when engine is curve. Advanced. |
| replicate_percent | boolean | no | report replicate spread as a PERCENTAGE of the mean rather than in degrees. Advanced. |
| replicate_robust | boolean | no | replicate spread as median and MAD rather than mean and SD. Engine-independent: it describes the readings, so every run carries it. Advanced. |
| true_peak_width | number | no | plate only: half-width of the window around expected_tm a peak must fall in to count as the product. In C. Only applies when engine is plate. Advanced. |
| expo_low_temp | number | no | plate only: low end of the window the EXPONENTIAL background is fitted over. In C. Only applies when norm_method is exponential or combined. Advanced. |
| expo_high_temp | number | no | plate only: high end of the exponential fit window. In C. Only applies when norm_method is exponential or combined. Advanced. |
| bilin_low_start_temp | number | no | plate only: start of the LOW seed window the bilinear background is fitted from. In C. Only applies when norm_method is bilinear or combined. Advanced. |
| bilin_low_stop_temp | number | no | plate only: end of the low seed window. In C. Only applies when norm_method is bilinear or combined. Advanced. |
| bilin_high_start_temp | number | no | plate only: start of the high seed window. NARROWER THAN IT LOOKS, and upstream's own quirk reproduced: the high baseline scan walks a hard-coded 90-91 C seed, so this knob feeds ONLY the first expo |
| bilin_high_stop_temp | number | no | plate only: end of the high seed window — same narrow effect as its start, for the same reproduced reason. In C. Only applies when norm_method is bilinear or combined. Advanced. |
Uncertainty through any qPCR quantity, three independent ways at once. Give it the expression you actually report - a ratio, a normalised expression, an efficiency-corrected quantity - and a mean and standard deviation for each variable in it (or the replicate observations themselves), and it returns the analytic Taylor propagation, a Monte-Carlo simulation and a permutation resampling side by sid
| Parameter | Type | Required | Notes |
|---|---|---|---|
| expression | string | yes | the quantity whose uncertainty is wanted, in R's syntax over the variable names below: x/y, 2^-(a - b), (Etar^-Cttar)/(Eref^-Ctref). Every name in it must appear in variables. |
| input | string | no | what variables holds. stat = a summary per variable; raw = the replicate observations. raw is the stronger input: it carries the measured covariance between variables and it is the only one th |
| variables | string | yes | the numbers. In stat mode: a header row variable, mean, sd and one row per variable. In raw mode: a header row of variable names and one row per replicate, blank cells left blank (they are dropp |
| second_order | boolean | no | include the second-order Taylor terms. On is upstream's default and is what makes the analytic arm usable on a ratio; off gives the classic first-order propagation of error. |
| use_cov | boolean | no | raw only: propagate the measured covariance between the variables, not just their variances. Two Ct values read off the same plate are not independent, and treating them as independent understates t |
| do_sim | boolean | no | run the Monte-Carlo arm — draw from the joint normal and push every draw through the expression. Correct for any nonlinearity, at the cost of being a sample. |
| nsim | number | no | Monte-Carlo draws. Only applies when do_sim is true. |
| dist_sim | string | no | the distribution drawn from: norm, or tnorm truncated at zero — the one to use when a variable is a concentration or a fluorescence and a negative draw is not a possible measurement. Only applies |
| do_perm | boolean | no | raw only: run the permutation arm, which resamples the observed rows and so assumes no distribution at all. It also returns p-values for the three hypotheses upstream tests. Only applies when input |
| nperm | number | no | permutations. Only applies when do_perm is true. |
| ties | string | no | raw only: which columns are resampled together, as one whole number per column — 1,1,2 permutes the first two as a block. Blank permutes every column on its own. Use it when two columns are readin |
| conf_level | number | no | the level the reported bounds are read at. |
| seed | number | no | R's set.seed value, so a simulated or permuted run is reproducible and citable. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Resampling error bars on ONE reaction's Cq. A Cq is read off a fitted model, so its uncertainty is how tightly the observations pin that model down - which propagating a measured spread cannot answer. This refits the curve a few hundred times, either by resampling its residuals or by leaving observations out, and reports the spread of everything the fit produces: every model coefficient, the Cq un
| Parameter | Type | Required | Notes |
|---|---|---|---|
| curves | string | yes | the amplification table: a header row, first column the cycle number and every other column one reaction's fluorescence. The same parser call_cq and the Curve->Cq tab use. |
| reaction | string | no | which reaction to resample, by its column name. Blank takes the first column — this is a per-reaction run by design, because at the default 200 iterations a 47-reaction plate would be 9,400 refits nob |
| model | string | no | the sigmoid fitted once and REFITTED on every iteration. It is not re-chosen per resample: Cqs fitted under different models are not comparable, so a mixture over models would make the quantiles mean |
| cq_method | string | no | which Cq definition the resampled efficiency readouts report. Values: cpD2 (cpD2 · second-derivative max), cpD1 (cpD1 · first-derivative max), maxE (maxE · cycle of maximum efficiency), expR (expR · e |
| scheme | string | no | boot resamples the fit's residuals (upstream's default); jack leaves observations out. The bootstrap answers "how would this Cq move under the same noise?", the jackknife "how much does any single |
| iterations | number | no | each iteration is a full nonlinear refit, so this is the run's whole cost. 100 is upstream's default and puts a 95 % bound on a single order statistic, which is why both doors open on 200. |
| drop | number | no | jackknife only: observations left out of each refit. 1 is the delete-one jackknife; more is a delete-d jackknife, which is less sensitive to a single influential cycle. Only applies when scheme is jac |
| conf_level | number | no | the level the reported bounds are read at — 0.95 puts them at the 2.5 % and 97.5 % quantiles of the iterations. |
| include_readouts | boolean | no | also resample every efficiency readout — the Cq definitions, the efficiency, the initial fluorescence — not just the model coefficients. On, because an interval on the Cq is the point; off is faster a |
| seed | number | no | R's set.seed value, so the interval is reproducible and citable. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
The MIQE 2.0 checklist for a qPCR paper (Bustin et al. 2025, Clin Chem 71:634, Table 1): every item in its five sections, with your answers. Each answer is Provided (yes or no) and Description/Justification: where in the article when yes, why it is omitted when no; an answer missing that is named. Returns every row, the counts and a TSV under the paper's headers. Run with no answers to read the it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| answers | object | no | answers by item id, e.g. {"5.8": {"provided": "yes", "description": "Results, Table 2: standard curve over five tenfold dilutions"}, "3.5": {"provided": "no", "description": "DNase-treated RNA validat |
| _subject | object | 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. |
| _files | array | 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. |
Power and sample size for a planned experiment: how many replicates a test needs to detect an effect, or what power, detectable effect or significance level a design that is already fixed gives. Leave ONE quantity out with solve_for and it is solved; everything else is given. Thirteen tests in two families: Cohen's standardized effect sizes (pwr 1.3-0: t one/two-sample/paired and unequal n, one
| Parameter | Type | Required | Notes |
|---|---|---|---|
| test | string | yes | which test the experiment will be analyzed with; the power answer belongs to that test and no other. Values: t (t test: one-sample, two-sample or paired, Cohen's d), t_unequal (two-sample t test, uneq |
| solve_for | string | no | the one quantity to solve. Left unset it is the test's sample size (n; n2 for unequal groups, N for chi-square, v for the linear model). effect solves the smallest detectable effect. |
| effect | number | no | the standardized effect: Cohen's d for t and normal-mean tests, h for proportions, r for correlation, w for chi-square, f for ANOVA, f² for the linear model. Give a value or effect_size instead. Onl |
| effect_size | string | no | Cohen's conventional small, medium or large effect for this test (pwr's cohen.ES), when there is no estimate from data. A convention, not a measurement, and every answer built on it says so. Only appl |
| n | number | no | observations per group (pairs, for paired; the sample, for one-sample and correlation). Only applies when test is t or two_proportions or one_proportion or normal_mean or correlation or anova or t_raw |
| n1 | number | no | observations in the first group. Only applies when test is t_unequal or two_proportions_unequal. |
| n2 | number | no | observations in the second group. Only applies when test is t_unequal or two_proportions_unequal. |
| N | number | no | total observations across every cell. Only applies when test is chisq. |
| df | number | no | degrees of freedom of the chi-square test: (cells − 1) for goodness of fit, (rows − 1)(columns − 1) for independence. Only applies when test is chisq. |
| k | number | no | number of groups. Only applies when test is anova. |
| groups | number | no | number of groups. Only applies when test is anova_raw. |
| u | number | no | numerator degrees of freedom: the number of predictors tested. Only applies when test is linear_model. |
| v | number | no | denominator degrees of freedom: n − u − 1 for n observations. Only applies when test is linear_model. |
| difference | number | no | δ, the true difference in means, in the measurement's units. Only applies when test is t_raw. |
| sd | number | no | the standard deviation, in the same units (of the differences, for paired); R's default is 1. Only applies when test is t_raw. |
| p1 | number | no | the proportion in group 1. Only applies when test is proportions_raw. |
| p2 | number | no | the proportion in group 2. Only applies when test is proportions_raw. |
| between_var | number | no | variance of the group means. Only applies when test is anova_raw. |
| within_var | number | no | variance within groups. Only applies when test is anova_raw. |
| sig_level | number | no | α, the type I error rate; R's default. |
The effect a power calculation needs, measured from a pilot instead of guessed: two groups of one measurement in a table, standardized as Hedges' g (default), Cohen's d or Glass's Δ with its noncentral-t confidence interval (effectsize 1.0.3, reproduced), and the two-sample t design sized at the estimate and at the interval limit nearest zero. A column can be subtracted row by row first (a referen
| Parameter | Type | Required | Notes |
|---|---|---|---|
| table | string | yes | the pilot: a header row, then one row per observation. Tab- or comma-separated. |
| value | string | yes | the column holding the measurement. |
| subtract | string | no | a column subtracted from the measurement row by row before anything else: a reference gene's Ct (giving delta-Ct), a baseline. |
| group_column | string | no | the column naming each row's group. Or give groups. |
| groups | string | no | one group label per data row, in row order, separated by commas, spaces or new lines, when the table has no group column. |
| group | string | no | the group compared. Left unset, the second group to appear. |
| reference | string | no | the group it is compared against (the control). Left unset, the first group to appear. |
| estimator | string | no | Hedges' g corrects Cohen's d's small-sample bias by the exact J(df); Cohen's d is the uncorrected standardized difference; Glass's Δ standardizes by the reference group's SD alone, for when the treatm |
| pooled_sd | boolean | no | standardize by the pooled SD (Student). Off averages the two variances, with Welch's df. Only applies when estimator is hedges_g or cohens_d. |
| paired | boolean | no | the two groups are the same subjects measured twice, paired by row order within each group. Only applies when estimator is hedges_g or cohens_d. |
| ci | number | no | the confidence level of the interval. |
| alternative | string | no | a two-sided interval, or one bounded on one side. Values: two.sided (Two-sided), less (Less (upper bound only)), greater (Greater (lower bound only)). Advanced. |
| power | number | no | size the design for this power; leave empty to estimate the effect only. |
| sig_level | number | no | α for the sizing. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Sample size and power for an RNA-seq comparison of two groups, one gene at a time: the biological replicates per group needed to detect a fold change at a given sequencing depth and within-group coefficient of variation, or the power, detectable fold change, CV or α a fixed design gives. Leave one of n, cv, effect, alpha and power out (or name it in solve_for). Every quantity takes a list, and t
| Parameter | Type | Required | Notes |
|---|---|---|---|
| solve_for | string | no | the quantity to solve. Left unset, it is the one of n, cv, effect, alpha and power that was not given. Values: n (n per group), cv (CV), effect (fold change), alpha (α), power (power). |
| depth | array | yes | average depth of coverage of the gene: its expected read count per sample. Hart et al. found most genes at 0.1 per million mapped reads, so 4 at 40 million. |
| n | array | no | biological replicates in group 1 (and in group 2, unless n2 is given). |
| n2 | array | no | replicates in group 2, one per n. Advanced. |
| cv | array | no | the biological coefficient of variation within a group: 0.4 or less for most genes in human studies, about 0.1 in inbred animals (Hart et al.). |
| cv2 | array | no | the CV within group 2, one per cv. Advanced. |
| effect | array | no | the fold change to detect; 2 and 0.5 are the same change. |
| alpha | array | no | α, the two-sided false-positive rate per gene. |
| power | array | no | 1 − β, the chance of detecting the change if it is real. No default: the target is yours to choose. |
| _subject | object | 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. |
| _files | array | 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. |
How many biological replicates an RNA-seq experiment needs when the question is about the WHOLE experiment rather than one gene: the exact negative-binomial test with the per-gene α derived from a target false discovery rate across m genes of which m1 are expected to move (RnaSeqSampleSize 2.23.0, Zhao et al. 2018; the test is Robinson & Smyth 2008's, edgeR's exactTest), or the AVERAGE power acros
| Parameter | Type | Required | Notes |
|---|---|---|---|
| method | string | no | which question. exact powers one prognostic gene with the exact negative-binomial test at an α derived from the FDR; average_power asks what the mean power across genes is when each gene's effect |
| solve_for | string | no | size the experiment, or score a design you already have. Values: n (Replicates per group), power (Power). |
| power | number | no | the power to reach, when solving n. |
| n | number | no | biological replicates in the control group, when solving power. Only applies when solve_for is power. |
| fdr | number | no | the false discovery rate to control across the experiment. |
| m | number | no | genes tested. Only applies when method is exact. |
| m1 | number | no | genes expected to be differentially expressed. Only applies when method is exact. |
| fold_change | number | no | ρ, the minimum fold change to detect in a prognostic gene. Only applies when method is exact. |
| count | number | no | λ₀, the average read count for a prognostic gene in the control group. Only applies when method is exact. |
| dispersion | number | no | φ₀, the negative-binomial dispersion of a prognostic gene — the square of the biological coefficient of variation. Only applies when method is exact. |
| size_ratio | number | no | k, the ratio of treatment to control group size. Only applies when method is exact. Advanced. |
| normalization_ratio | number | no | w, the ratio of the two groups' normalization factors. Only applies when method is exact. Advanced. |
| counts | array | no | a pilot's average read count per gene. With dispersions, the power is computed for each of these genes and averaged, instead of for one idealised gene. Only applies when method is exact. |
| dispersions | array | no | the dispersion of each gene in counts, in the same order. Only applies when method is exact. |
| effect_mean | number | no | the mean of the normal each gene's true log-fold-change is drawn from. Only applies when method is average_power. |
| effect_sd | number | no | the spread of those true effects ACROSS genes; 0 would make every gene identical. Only applies when method is average_power. |
| sigma | number | no | the common within-gene standard deviation on that scale. Only applies when method is average_power. |
| pi0 | array | no | the proportion of genes with no effect. A list asks the question once per proportion, which is how the answer's sensitivity to it is read. Only applies when method is average_power. |
| max_n | number | no | the largest replicate count to search. Only applies when method is average_power. Advanced. |
| _subject | object | 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. |
Power and FDR for a two-group RNA-seq experiment by SIMULATION (PROPER 1.44.0): whole experiments drawn from a real pilot (Cheung, Gilad, Bottomly, MAQC, or a sequencing depth), each run through edgeR's exact test at every sample size. Reports power stratified by expression, the FDR actually achieved, true and false calls, and power at other depths; reproducible from its seed, value for value agai
| Parameter | Type | Required | Notes |
|---|---|---|---|
| pilot | string | no | where each gene's baseline expression comes from: one of PROPER's pilots, a sequencing depth applied to aggregated human expression, or one constant. Values: cheung (Cheung (unrelated people, large di |
| reads_per_sample | number | no | total reads per sample. Only applies when pilot is depth. |
| log_mean | number | no | the natural-log mean count every gene shares. Only applies when pilot is constant. |
| dispersion | number | no | one dispersion (BCV²) for every gene, instead of the pilot's; left unset, the pilot's own. Advanced. |
| dispersion_pilot | string | no | take dispersions from this pilot instead (with a depth or a constant baseline, Cheung's unless set). Advanced. |
| genes | number | no | genes in the simulated experiment. |
| changed_fraction | number | no | the proportion of genes that are differentially expressed. |
| log_fold_change | number | no | one log fold change for every DE gene; left unset, PROPER's normal(0, 1.5) draws. Advanced. |
| replicates | array | no | replicates per group at each sample size to evaluate. |
| second_group | array | no | replicates in the second group at each size, when the groups differ. Advanced. |
| rounds | number | no | simulated experiments. PROPER's own default is 100; each is a full edgeR run at every sample size, so time grows with it. |
| seed | number | no | the seed; round i uses seed + i, as PROPER does. Advanced. |
| call_by | string | no | call a gene by its FDR or its raw p-value. Values: fdr (FDR), pval (raw p-value). |
| cutoff | number | no | the cut-off a gene is called at. |
| target | string | no | which DE genes count as worth finding: by |log fold change|, or by |log fold change| / √dispersion. Values: lfc (Log fold change), effectsize (Effect size). |
| threshold | number | no | the threshold a DE gene's size must exceed to count. |
| stratify_by | string | no | stratify the power by expression (mean normalized count) or by dispersion. Values: expr (Expression), dispersion (Dispersion). Advanced. |
| strata | array | no | stratum break points; unset, PROPER's: 0, 10, 20, 40 … 1280, ∞ for expression. Advanced. |
| filter_by | string | no | drop the lowest expression strata before counting, and recompute BH over what is left. Values: none (Keep every gene), expr (Drop low expression). Advanced. |
| dropped_strata | array | no | which strata (1-based) to drop. Only applies when filter_by is expr. Advanced. |
Which candidates in a table are not beaten on every objective at once: Pareto (non-dominated) sorting of rows scored on several columns, each to maximize or minimize. Returns each candidate's front (1 = non-dominated), the candidate one front up that beats it, and its crowding distance within its front (how isolated it is, so a short list can be spread along the front). Rows can be filtered first
| Parameter | Type | Required | Notes |
|---|---|---|---|
| table | string | yes | the candidates: a header row, then one row per candidate. Comma- or tab-separated, quoted cells allowed. |
| maximise | string | no | the columns where higher is better, separated by commas. |
| minimise | string | no | the columns where lower is better, separated by commas. |
| label | string | no | the column naming each candidate. Left unset, the first column. |
| filter | string | no | keep only rows passing every clause, separated by commas: a column, one of = != >= <= > <, and a value (em_max>=580, agg=m). Numbers compare as numbers; a blank cell passes no ordering clause. |
| crowding | string | no | how isolation along a front is measured: NSGA-II's normalized distance (each gap over the objective's range, averaged), or the raw sum of gaps in each objective's own units. Values: normalised (NSGA-I |
| keep_duplicates | boolean | no | keep every copy of candidates with identical values on the first front; off keeps the first copy and names it as what the others duplicate. Advanced. |
| order | string | no | what orders candidates within a front: crowding distance (how isolated each is), or exclusive hypervolume contribution (how much of the objective space the front loses without it). Values: crowding (c |
| reference | string | no | the hypervolume's reference point, one column=value per objective (brightness=0, maturation=500), each worse than every candidate. Left unset, each objective's worst value pushed out by 10% of its |
| _subject | object | 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. |
| _files | array | 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. |
Solve C₁V₁ = C₂V₂ for whichever of the four quantities is left empty (stock concentration, stock volume, final concentration, final volume), each in its own unit: molar (M to fM), mass per volume (mg/mL to ng/mL), fold (X) or percent. Returns all four, the fold and the diluent volume to add. Refuses a 'dilution' that would raise the concentration, and two concentrations of different dimensions.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| stock_concentration | number | no | stock concentration (C₁). Leave exactly one of the four quantities empty: that one is calculated. |
| stock_concentration_unit | string | no | the unit of the stock concentration, given or solved. |
| stock_volume | number | no | stock volume (V₁). Leave exactly one of the four quantities empty: that one is calculated. |
| stock_volume_unit | string | no | the unit of the stock volume, given or solved. |
| final_concentration | number | no | final concentration (C₂). Leave exactly one of the four quantities empty: that one is calculated. |
| final_concentration_unit | string | no | the unit of the final concentration, given or solved. |
| final_volume | number | no | final volume (V₂). Leave exactly one of the four quantities empty: that one is calculated. |
| final_volume_unit | string | no | the unit of the final volume, given or solved. |
| _subject | object | 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. |
| _files | array | 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. |
Plan a serial dilution: the same fold dilution repeated tube after tube from a stock, each tube made to one volume. Returns the transfer and diluent volumes for every step, each tube's concentration and cumulative dilution, and what each tube holds after giving its transfer to the next.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| stock_concentration | number | yes | concentration of the stock the series starts from. |
| stock_concentration_unit | string | no | the unit of the stock concentration, which every tube is reported in. |
| fold | number | no | the dilution at each step, as a fold (1:10 is 10). |
| steps | number | no | how many dilutions to make. |
| tube_volume | number | yes | the volume of each dilution after mixing (transfer plus diluent). |
| tube_volume_unit | string | no | the unit of the tube volume. |
| _subject | object | 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. |
| _files | array | 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. |
Convert a mass of a molecule to an amount in moles and a number of molecules, or an amount back to a mass. The weight is the open record's own, computed from its sequence (both strands of a double-stranded record under its topology, a protein from its residues), or one you give.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| mass | number | no | the mass to convert. Leave it or amount empty: the empty one is calculated. |
| mass_unit | string | no | the unit of the mass, given or solved. |
| amount | number | no | the amount in moles to convert. Leave it or mass empty. |
| amount_unit | string | no | the unit of the amount, given or solved. |
| molecular_weight | number | no | g/mol. Leave empty to weigh the open record from its sequence; give it for a molecule that is not open. In g/mol. Advanced. |
| strands | string | no | which strands of the open record to weigh. From the record weighs both strands of DNA and the one strand of an RNA (U and no T); choose one strand for an oligo. Values: record (From the record), doubl |
| _subject | object | 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. |
| _files | array | 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. |
Scale one PCR reaction into a master mix for N reactions plus overage. Starts from a vendor's own published reaction setup (scaled to any reaction volume in proportion to the vendor's columns, so every final concentration is the vendor's, with water making up the volume and the template added per tube), or from your own component list. Returns each component per reaction and in the mix, the mix to
| Parameter | Type | Required | Notes |
|---|---|---|---|
| setup | string | no | the vendor reaction setup to scale. Ignored when components is given. Values: neb-phusion-m0530 (Phusion High-Fidelity DNA Polymerase (M0530)), takara-taq-r001a (TaKaRa Taq (R001A)), takara-ex-taq-r |
| reaction_volume | number | no | volume of one reaction, µl. Each vendor publishes its setup at one or two volumes (25, 50 or 100 µl; NEB's Phusion at 20 and 50); any volume scales from them. In µl. |
| template_volume | number | no | template DNA per reaction, µl, added to each tube rather than the mix. The vendor states an amount, not a volume (NEB Phusion: < 250 ng), so the volume is yours. In µl. Only applies when components is |
| primer_final | number | no | final concentration of each primer, µM. Most vendors state primers as a range rather than a volume; unset uses the setup's own value (its single stated value, else the low end of its range). In µM. On |
| primer_stock | number | no | concentration of your primer stock, µM; each primer's volume is its final concentration diluted from this stock. In µM. Only applies when setup is takara-taq-r001a or takara-ex-taq-rr001a or takara-la |
| mg_final | number | no | total Mg²⁺ in the reaction, mM, reached by adding the vendor's 25 mM MgCl2 on top of what the buffer holds. Unset uses the vendor's default. Offered by QIAGEN Taq DNA Polymerase (201203), QIAGEN HotSt |
| include_dmso | boolean | no | include the setup's optional DMSO (3% final). Offered by Phusion High-Fidelity DNA Polymerase (M0530); the setup's notes say when to use it. Only applies when setup is neb-phusion-m0530. |
| include_q_solution | boolean | no | include the setup's optional Q-Solution (1x (from the 5x stock) final). Offered by QIAGEN Taq DNA Polymerase (201203), QIAGEN HotStarTaq DNA Polymerase (203203); the setup's notes say when to use it. |
| reactions | number | no | how many reactions the mix is for. |
| overage | number | no | extra mix for pipetting loss, as a percent of the N-reaction volume. In %. |
| components | array | no | your own recipe instead of a vendor setup: objects of { name, perReaction (µl), fill (true on the one component that makes up the volume), perTube (true to add it to each tube instead of the mix) }. A |
| _subject | object | 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. |
| _files | array | 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. |
Recombination between molecules — Gateway BP/LR (att sites), Cre/loxP, a serine integrase whose two half-sites you supply, plain homologous recombination through shared arms, or a CRISPR knock-in that keeps only products whose repair region contains every guide's cut. Emits the first product as a NEW record for downstream nodes.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fragments | array | no | the molecules to react — wire upstream record outputs here, or name library documents. |
| include_subject | boolean | no | also include the node's subject as a reactant. |
| system | string | no | recombination system. Values: gateway-BP (Gateway BP (attB × attP → entry)), gateway-LR (Gateway LR (attL × attR → expression)), cre-lox (Cre / loxP), recombinase (Serine integrase (your two half-site |
| greedy | boolean | no | permissive att core matching. Only applies when system is gateway-BP or gateway-LR. Advanced. |
| multi_site_only | boolean | no | keep only products where BOTH sites recombined (drops single-site intermediates). Only applies when system is gateway-BP or gateway-LR. |
| circular_only | boolean | no | report only circular products. |
| site1 | string | no | the recombinase's first half-site (e.g. attP). Case is meaningful: the lower-case middle is the overlap the enzyme crosses over in. Only applies when system is recombinase. |
| site2 | string | no | the recombinase's second half-site (e.g. attB), same convention. Only applies when system is recombinase. |
| homology_bp | number | no | shortest homology arm that counts as a shared end. In bp. Only applies when system is homologous or crispr-knock-in. |
| guides | array | no | protospacers whose cut must fall inside the repaired region — a product cut elsewhere by any of them is discarded and counted. Only applies when system is crispr-knock-in. |
| _subject | object | 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. |
| _files | array | 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. |
Compare EVERY assembly chemistry this engine has against one set of parts, and say what each one costs and risks. It runs them all, keeps the ones that really produce a construct, and reports the rest with the refusal the chemistry itself gave — so 'Golden Gate is the only way to build this, and its overhangs ligate correctly 99.8% of the time' is one step rather than six runs and a spreadsheet. T
| Parameter | Type | Required | Notes |
|---|---|---|---|
| parts | array | no | the parts to assemble, in order — order is meaningful for Type-IIS. Wire records in, or name project documents. |
| order_by | string | no | which criterion to order the feasible strategies by. Every criterion is reported for every strategy whichever one you pick. Values: steps (Steps (lower is better)), junctions (Junctions (lower is bett |
| enzyme | string | no | Type-IIS enzyme for the chemistries that use one. auto is DnaCauldron's own default: it picks the enzyme from the sites the parts carry. |
| digest_enzymes | array | no | the enzymes a verification digest may use. Left unset the run uses your active enzyme collection; with neither, the diagnostic-digest criterion is reported as unavailable rather than guessed, because |
| _subject | object | 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. |
| _files | array | 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. |
Ligate fragments by their overhangs (pydna ligation_assembly) — sticky, optionally blunt. Each input may be digested by its own enzymes first, which is the digest → ligate hand-off. Emits the first product as a NEW record.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fragments | array | no | the fragments to ligate — wire upstream record outputs here, or name library documents. |
| include_subject | boolean | no | also include the node's subject as a fragment. |
| enzymes | array | no | digest every input with these enzymes before ligating. Left unset, the run uses your active enzyme collection. |
| fragment_indices | array | no | which band to take from each input's digest, positionally (0 = first fragment). Leave empty to use every fragment — which frequently yields no product, exactly as at the bench. |
| blunt | boolean | no | allow blunt-end joins as well as sticky. |
| allow_partial_overlap | boolean | no | allow partially overlapping sticky ends. Advanced. |
| circular_only | boolean | no | report only circular products. |
| end_origins | array | no | what MADE each input's ends, positionally — this fixes the 5'-phosphate before any treatment. Leave empty for unspecified, which is treated as phosphorylated and reproduces a run with no end chemist |
| end_treatments | array | no | the phosphatase or kinase applied to each input AFTER it was made, positionally. Dephosphorylating the vector is what stops it self-ligating; a junction with no 5'-phosphate on either strand forms no |
| fill_in | array | no | positional booleans: fill that input's 5' overhangs with Klenow after its digest, so its cut ends join blunt (needs blunt). Each join then reports the bases the fill-in added. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Cut and ligate in ONE POT (pydna restriction_ligation_assembly): every input is digested by the same enzymes inside the reaction and the pieces are joined as they appear, so a junction that re-forms a recognition site can be cut again. This is the reaction Golden Gate is a special case of, and it is a different chemistry from ligate_fragments, which digests first and then ligates whatever the dige
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fragments | array | no | the molecules to put in the pot — wire upstream record outputs here, or name library documents. |
| include_subject | boolean | no | also put the node's subject in the pot. |
| enzymes | array | no | the enzymes in the pot — used for every input. Left unset, the run uses your active enzyme collection. |
| blunt | boolean | no | allow blunt-end joins as well as sticky. |
| circular_only | boolean | no | report only circular products. |
| sort_by_recognition_sites | boolean | no | sort products by how many sites of the FIRST enzyme they still carry, fewest first — this floats the finished construct to the top. |
| end_origins | array | no | what MADE each input's ends, positionally. In a one-pot reaction almost every end is cut INSIDE the tube and is therefore freshly 5'-phosphorylated, so this changes the answer only for an input's own |
| end_treatments | array | no | the phosphatase or kinase applied to each input, positionally. Same reach as end_origins: an original sticky terminus only. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Join fragments without a ligase by one of the five named methods — LIC, SLIC, In-Fusion, CPEC or USER (pydna). Each method's chemistry decides which end survives, and its own authority states the arm it needs.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fragments | array | no | the fragments to join — wire upstream record outputs here, or name library documents. |
| include_subject | boolean | no | also include the node's subject as a fragment. |
| method | string | no | the cloning method, which decides the chemistry: LIC and SLIC and In-Fusion chew 3' ends, CPEC removes nothing, USER excises a uracil. Values: lic (LIC), slic (SLIC), in-fusion (In-Fusion), cpec (CPEC |
| arm_nt | number | no | homology per junction. Left unset, the method's own recommended arm is used (In-Fusion widens its own for more than one insert). In nt. |
| circular_only | boolean | no | report only circular products. |
| _subject | object | 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. |
| _files | array | 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. |
Overlap-extension (fusion) PCR — join fragments that share terminal homology into one product, carrying their features across (pydna). Emits the fused product as a NEW record.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| fragments | array | no | the fragments to fuse, in order — wire upstream record outputs here, or name library documents. |
| include_subject | boolean | no | also include the node's subject as the first fragment. |
| limit | number | no | minimum shared terminal homology two fragments must have to fuse (pydna's own default is 15). In bp. |
| _subject | object | 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. |
| _files | array | 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. |
Design a combinatorial library in one step: SLOTS, each offering a bin of interchangeable parts, plus the CONSTANTS every member carries. The member set is the Cartesian product of the bins — one part per slot — pruned by design rules, and each surviving member is assembled by the SAME end-homology (Gibson/NEBuilder/In-Fusion) or plain-concatenation engine the single-construct tools use, so a memb
| Parameter | Type | Required | Notes |
|---|---|---|---|
| bins | array | yes | the variable slots: each {slot, parts} names a slot and the interchangeable parts (record names/ids, or wired record outputs) that may fill it. The member set is the Cartesian product across bins. |
| constants | array | no | parts every member carries, assembled before the slot choices — the backbone and any fixed linker. |
| chemistry | string | no | gibson is terminal-homology assembly (Gibson/NEBuilder/In-Fusion/homology, one engine); concat is a deterministic head-to-tail join with no homology or digest. Values: gibson (End homology (Gibson |
| rules | array | no | j5/Eugene design rules that prune combinations: {kind:'notWith',a,b} (never together), {kind:'with',a,b} (if a then b), {kind:'notMoreThan',part,count} (at most count copies, constants included). Adva |
| topology | string | no | Gibson only: which products to enumerate per member. Values: circular (Circular), linear (Linear), both (Both). Advanced. |
| min_homology_bp | number | no | Gibson only: shortest terminal homology that counts as a join. In bp. Advanced. |
| max_members | number | no | cap on Cartesian members enumerated, before pruning. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
A QC gate. Compares a wired value against a threshold and PASSES or FAILS the pipeline there — every node downstream of a failed gate is skipped, so a run stops at the first check that does not hold. This is how a pipeline expresses 'only continue if the clone is right'.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| value | number | yes | the value to check — wire a number (cut count, product size, tip count, Tm) or any output; a list is compared by its length. |
| operator | string | no | how to compare. Values: == (equals), != (does not equal), > (greater than), >= (at least), < (less than), <= (at most), between (between (inclusive)), in (is one of), not_in (is none of), contains (co |
| threshold | number | no | the value to compare against. Leave it unset and wire against instead to compare two steps. Only applies when operator is == or != or > or >= or < or <=. |
| against | number | no | optional: compare against another step's value instead of the fixed threshold. When wired, this wins over threshold. Only applies when operator is == or != or > or >= or < or <=. |
| against_factor | number | no | multiply the compared-against value by this first, so at least twice the smallest band is one gate rather than an arithmetic step. Only applies when operator is == or != or > or >= or < or <=. |
| against_offset | number | no | then add this, so within 50 bp of the predicted size is expressible against a computed value. Only applies when operator is == or != or > or >= or < or <=. |
| min | number | no | lower bound, inclusive. Only applies when operator is between. |
| max | number | no | upper bound, inclusive. Only applies when operator is between. |
| set | array | no | the values the checked value must be one of (or none of), compared as text, so 1 matches 1. Only applies when operator is in or not_in. |
| text | string | no | the text the value must contain. Only applies when operator is contains. |
| label | string | no | what this gate is checking, in your words — it becomes the message when the gate fails (e.g. 'single EcoRI site'). |
| report_only | boolean | no | report the verdict instead of stopping the run: wire passed (or failed) into another step's condition to choose a branch. |
| record | string | no | optional: the record this gate is guarding. It comes straight back out of the record output when the check passes, so the gate sits in the middle of a chain. |
| _subject | object | 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. |
| _files | array | 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. |
Keep only the rows of a table-shaped output that meet a condition — the bands above a size, the guides over a score, the assays under a penalty. Emits the kept rows plus how many were dropped, so a downstream gate can act on the count.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | the rows to filter — wire a json/list output (bands, guides, assays, amplicons). |
| field | string | no | which field of each row to test (e.g. size, score, length). Leave empty to test the row itself when it is a plain number. |
| operator | string | no | how to compare. Values: == (equals), != (does not equal), > (greater than), >= (at least), < (less than), <= (at most), between (between (inclusive)), in (is one of), not_in (is none of), contains (co |
| value | number | no | the value to compare against. Only applies when operator is == or != or > or >= or < or <=. |
| text | string | no | the text a field must contain. Only applies when operator is contains. |
| min | number | no | lower bound, inclusive. Only applies when operator is between. |
| max | number | no | upper bound, inclusive. Only applies when operator is between. |
| set | array | no | the values the field must be one of (or none of). Only applies when operator is in or not_in. |
| _subject | object | 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. |
| _files | array | 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. |
The region selected on the canvas, as its own record. This is what makes a highlighted stretch a pipeline INPUT: wire its record into any node's subject and that step runs on the selection rather than on the whole molecule.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reverse_complement | boolean | no | emit the bottom strand of the selection (what a feature on the minus strand actually reads). |
| pad | number | no | extend the selection by this many bases on each side, clamped to the molecule (or wrapped, on a circular one). In bp. |
| _subject | object | 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. |
| _files | array | 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. |
Rejoin two branches: takes the outputs of several conditional steps and emits the first one that actually ran. This is how a two-way branch comes back together: wire both arms in, and whichever arm ran is what continues.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| values | array | no | the branches to choose between, in preference order. Wire one output from each arm. |
| fallback | string | no | what to emit when NO branch ran. Leave empty to make that an error instead, which is usually what you want, because silently continuing with nothing is how a pipeline reports a result it never compute |
| _subject | object | 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. |
| _files | array | 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. |
A QC gate over a TABLE: assert something about every row at once (every band inside a size window, no guide above an off-target score, at least three assays under a penalty). Fails the pipeline (so everything downstream skips) and names the rows that broke the rule.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | the rows to check. Wire a json/list output (bands, guides, assays, amplicons). |
| field | string | no | which field of each row to test (e.g. size, score). Leave empty when the rows are plain numbers. |
| require | string | no | what must hold across the table. Values: all (every row), any (at least one row), none (no row), at_least (at least N rows), at_most (at most N rows), exactly (exactly N rows). |
| count | number | no | N, for the counted requirements. Only applies when require is at_least or at_most or exactly. |
| operator | string | no | how each row is compared. Values: == (equals), != (does not equal), > (greater than), >= (at least), < (less than), <= (at most), between (between (inclusive)), in (is one of), not_in (is none of), co |
| value | number | no | the value to compare against. Only applies when operator is == or != or > or >= or < or <=. |
| min | number | no | lower bound, inclusive. Only applies when operator is between. |
| max | number | no | upper bound, inclusive. Only applies when operator is between. |
| set | array | no | the values the field must be one of (or none of). Only applies when operator is in or not_in. |
| text | string | no | the text the field must contain. Only applies when operator is contains. |
| label | string | no | what this gate is checking, in your words. It becomes the message when it fails. |
| report_only | boolean | no | report the verdict instead of stopping the run: wire passed (or failed) into another step's condition to choose a branch. |
| record | string | no | optional: the record this gate is guarding. It comes back out of record when the check passes, so the gate sits in the middle of a chain. |
| _subject | object | 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. |
| _files | array | 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. |
Reduce a whole TABLE column to one number — the largest band, the median guide score, the spread of a set of melting temperatures. This is what makes a CROSS-ROW check expressible: check_rows can only assert the same thing of every row, so "the largest fragment is at least twice the smallest" needed two summaries and a comparison and had nowhere to come from. Name a group_field and it summariz
| Parameter | Type | Required | Notes |
|---|---|---|---|
| items | array | yes | the rows to summarize. Wire a json/list output (bands, guides, assays, amplicons). |
| field | string | no | which field of each row to reduce (e.g. size, score). Leave empty when the rows are plain numbers; a tuple row is indexed by number, so 0 is the first column. |
| operation | string | no | which summary to take. The vocabulary is GNU datamash's, so a number here is the number datamash <op> gives for the same column. The last four relate TWO columns and need a second_field. Values: s |
| group_field | string | no | split the rows by this field first and summarize each group: template on a multiplex screen, strand on a guide table. Leave empty to summarize the whole table. |
| second_field | string | no | the second column for the pairwise operations, the one this field is related TO (e.g. gc against size). Only applies when operation is scov or pcov or spearson or ppearson. |
| trim | number | no | the fraction to drop from EACH end before averaging, 0-0.5. datamash's own bound: 0.5 keeps only the middle value. Only applies when operation is trimmean. |
| percentile | number | no | which percentile to take, 0–100. In %. Only applies when operation is perc. |
| label | string | no | what this summary IS, in your words. It becomes the message the run reports. |
| _subject | object | 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. |
| _files | array | 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. |
Screen a primer POOL against one or more templates: every predicted product, per-primer off-target binding, the pairs that tell templates apart on a gel, and the all-against-all primer-dimer matrix a pool actually lives or dies by (pydna primer_screen + primer3 thal).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| primers | array | no | the primer pool — literal sequences, or wire primer outputs from upstream design nodes. |
| templates | array | no | extra templates to screen against — wire records or name library documents (the subject is included by default). |
| include_subject | boolean | no | screen against the node's subject as a template. |
| limit | number | no | minimum 3' footprint match for a primer to be considered bound (pydna's own default is 16). In bp. |
| min_size | number | no | smallest product to report. In bp. |
| max_size | number | no | largest product to report. In bp. |
| conditions | object | no | the reaction buffer every temperature here is computed in - Na+/K+/Tris/Mg2+/dNTPs, the primer concentration, the salt-correction method and the melting model. Left unset it is filled from your reacti |
| pool | boolean | no | also partition the screened reactions into compatible tubes (MultiPLX grouping), judged by the preset and cutoffs below. |
| pool_preset | string | no | which authority's limits a tube is judged by: MultiPLX's three stringencies, or primer3's own structural limits (calibrated for the ΔG engine computing the scores). Only applies when pool is true. |
| max_groups | number | no | most tubes the pool may be split into. Only applies when pool is true. |
| max_per_group | number | no | most reactions one tube may hold. Only applies when pool is true. |
| cutoff_prim_prim_end2 | number | no | Primer–primer, both 3′ ends [kcal/mol]: A blunt 3′–3′ dimer: each primer can extend on the other, so the pair consumes itself and makes a short artefact band. Unset keeps the preset's value. In kcal/m |
| cutoff_prim_prim_end1 | number | no | Primer–primer, one 3′ end [kcal/mol]: One primer's 3′ end anneals anywhere on the other. Extendable, so it competes with the template. Unset keeps the preset's value. In kcal/mol. Only applies when po |
| cutoff_prim_prim_any | number | no | Primer–primer, anywhere [kcal/mol]: Any duplex between two primers. Not extendable on its own, but it takes primer out of the reaction. Unset keeps the preset's value. In kcal/mol. Only applies when p |
| cutoff_prim_prod_end1 | number | no | Primer–product, 3′ end [kcal/mol]: A primer's 3′ end annealing inside another reaction's amplicon: it primes on the wrong molecule. Unset keeps the preset's value. In kcal/mol. Only applies when pool |
| cutoff_prim_prod_any | number | no | Primer–product, anywhere [kcal/mol]: Any duplex between a primer and another reaction’s amplicon. Unset keeps the preset's value. In kcal/mol. Only applies when pool is true. Advanced. |
| cutoff_max_prim_prim_any_tm | number | no | Cross-dimer Tm, anywhere [°C]: primer3's own limit, on the scale our ΔG engine is calibrated for. A dimer melting above this competes with template annealing. Unset keeps the preset's value. In °C. On |
| cutoff_max_prim_prim_end_tm | number | no | Cross-dimer Tm, 3′ end [°C]: primer3's limit for the 3′-end dimer: the configuration that extends. Unset keeps the preset's value. In °C. Only applies when pool is true. Advanced. |
| cutoff_min_prod_len_diff | number | no | Band separation (ladder) [bp]: Products in one tube must differ by at least this much, or the bands co-migrate and you cannot tell which reaction worked. Unset keeps the preset's value. In bp. Only ap |
| cutoff_max_prod_len_diff | number | no | Band spread (range) [bp]: Products in one tube must differ by no more than this, so one extension time suits them all. Unset keeps the preset's value. In bp. Only applies when pool is true. Advanced. |
Read a structure file — PDB, PDBx/mmCIF, or a core CIF small-molecule crystal structure — and report what is in it: the chains and what kind each is, their sequences, the ligands and ordered solvent, the disulfides, the residues the depositor declared modified, the temperature-factor range, the unit cell and space group, the resolution and the experiment. Use it to answer what a structure IS befor
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | the coordinate file's contents — a PDB flat file, a PDBx/mmCIF, or a core CIF; the format is read from the bytes, not from a name, because .cif is shared by two unrelated dictionaries. |
| model | number | no | which model of an ensemble to describe, 1-based. An NMR entry holds many complete conformers and they are alternatives rather than parts, so the counts always describe ONE of them. The upper bound is |
| _subject | object | 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. |
| _files | array | 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. |
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.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (one-letter amino acids); may hold several domains, e.g. an scFv. |
| scheme | string | no | numbering scheme. Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), martin (Martin (enhanced Chothia)), aho (AHo), wolfguy (Wolfguy). |
| cdrDefinition | string | 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) |
| species | array | no | species whose HMMs are preferred for the hit and whose germlines are searched (ANARCI's default: human and mouse). |
| chainTypes | array | no | chain types to number: H, K, L (antibody); A, B, G, D (TCR). Others are still listed in the hit table. |
| assignGermline | boolean | no | assign the closest V and J germline genes. |
| bitScoreThreshold | number | no | minimum HMMER bit score for a domain to count (ANARCI's default 80). |
| _subject | object | 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. |
| _files | array | 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. |
Scan antibody and TCR variable domains for sequence liabilities (Asn deamidation, Asp isomerization, N-glycosylation sequons, Asp-Pro cleavage, Met and Trp oxidation, unpaired or missing conserved cysteines), each placed in its IMGT region so CDR hits can be told from framework ones. Every motif is cited to its source.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (one-letter amino acids). |
| rules | array | no | which liabilities to report (default: all). |
| cdrOnly | boolean | no | report only liabilities that start inside a CDR. |
| _subject | object | 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. |
| _files | array | 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. |
Humanize an antibody variable domain with Sapiens, the antibody language model behind BioPhi: score every position against human repertoires, take the highest-scoring residue in the frameworks, and keep the parental CDRs (and optionally the Kabat Vernier zone). Reports every mutation, and what the model would change next. Validated against the published PyTorch model on every chain of ANARCI's PDB
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (one-letter amino acids); the variable domains in it are found and numbered first. |
| domain | number | no | which variable domain to humanize when the sequence holds several (0-based, in sequence order). |
| iterations | number | no | Sapiens passes, each re-scoring the previous output (BioPhi's default 1). |
| cdrDefinition | string | no | which CDR definition marks the residues kept from the parental antibody. Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), north (North). |
| humanizeCdrs | boolean | no | humanize the CDRs too instead of grafting the parental ones back (raises the risk of losing binding). |
| backmutateVernier | boolean | no | also keep the parental residues at the Kabat Vernier positions, which support the CDR loops. |
| _subject | object | 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. |
| _files | array | 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. |
Humanize an antibody variable domain by CDR grafting: find the closest human germline V and J, merge them into an acceptor framework, and put the parental CDRs onto it. The classical humanization route, and the counterpart to humanize_antibody's language model. Reproduces abnumber 0.4.4 over every antibody chain of ANARCI's PDB benchmark.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (one-letter amino acids); the variable domains in it are found and numbered first. |
| domain | number | no | which variable domain to graft when the sequence holds several (0-based, in sequence order). |
| cdrDefinition | string | no | which CDR definition decides what is grafted from the parental antibody. Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), north (North). |
| vGene | string | no | use this human V germline instead of the closest one (a family, gene or allele: IGHV1, IGHV1-18, IGHV1-18*01). |
| jGene | string | no | use this human J germline instead of the closest one. |
| top | number | no | graft onto the n-th closest germline instead of the closest (0-based). |
| backmutateVernier | boolean | no | keep the parental residues at the Kabat Vernier positions, the framework residues that support the CDR loops. |
| rankByFrameworks | boolean | no | rank germlines on framework identity alone, ignoring the CDRs. |
| _subject | object | 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. |
| _files | array | 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. |
Name the CONSTANT region of an antibody chain: which immunoglobulin gene and allele it carries (IGHG1, IGHA2, IGKC, IGLC2 …), and where each IMGT domain sits on it — CH1, the hinge, CH2, CH3, the secretory tail and the membrane exons, or the single C region of a light chain. A domain search says 'a C1-set immunoglobulin domain'; this says which isotype it is. Reads IMGT/GENE-DB's own per-label tra
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the chain (one-letter amino acids); the constant region in it is found, so a whole heavy chain is fine. |
| species | string | no | only consider genes of this species, spelled as IMGT spells it (Homo sapiens, Mus musculus). Left out, every species in the catalogue competes and the answer says which won. |
| minIdentity | number | no | a domain matching less of its reference than this is not reported. |
| _subject | object | 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. |
| _files | array | 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. |
Properties of an assembled antibody from its heavy and light chains: molecular weight, isoelectric point, net charge at a pH, and the extinction coefficient and A280 with cysteines reduced and with every pair formed into a cystine, for a Fab (1 heavy + 1 light) or an IgG (2 + 2). Each chain keeps its own termini, so this is not the same as pasting the chains end to end. Graded against Biopython Pr
| Parameter | Type | Required | Notes |
|---|---|---|---|
| heavy | string | yes | the heavy chain (one-letter amino acids), as much of it as the molecule carries. |
| light | string | yes | the light chain (kappa or lambda, one-letter amino acids). |
| format | string | no | how many copies of each chain the molecule holds. Values: fab (Fab (1 heavy + 1 light)), igg (IgG (2 heavy + 2 light)). |
| pH | number | no | the pH the net charge is reported at. |
| _subject | object | 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. |
| _files | array | 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. |
Type the ANTIBODY-ANTIGEN INTERFACE of a deposited complex: which residue of each antibody chain touches which residue of the antigen, how close, and what kind of interaction each pair makes - ionic, polar, weak polar, hydrophobic, aromatic, carbonyl, or a disulfide. The antigen is found rather than named: a protein chain with no immunoglobulin variable domain is the thing being bound. Geometric d
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | the coordinate file's contents - a PDB flat file or a PDBx/mmCIF; the format is read from the bytes, not from a name. |
| model | number | no | which model of an ensemble to type, 1-based: conformers touch in different places, so one is typed rather than all. |
| antibodyChain | string | no | type only this chain against the antigen. Left out, every chain carrying a variable domain is typed. |
| antigenChains | string | no | comma-separated chain ids to treat as the antigen. Left out, every protein chain with no variable domain is the antigen. |
| interactingCutoff | number | no | atom pairs further apart than this (Å) are not reported at all; Arpeggio's own default is 5. |
| _subject | object | 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. |
| _files | array | 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. |
Several antibodies side by side: each record numbered by ANARCI, its heavy or its light variable domains aligned column by column by their numbering (a column is one scheme position, so nothing is re-aligned and an insertion is its own column), the CDR of every column under the chosen definition, how many columns agree, and the same properties read off each V domain: length, mass, isoelectric poin
| Parameter | Type | Required | Notes |
|---|---|---|---|
| antibodies | array | no | the antibody chains to compare: wire several upstream records here, or list library documents or protein sequences. |
| include_subject | boolean | no | also compare the open record. |
| chain | string | no | which variable domains to align: heavy, or light (kappa and lambda together). Values: heavy (Heavy), light (Light (kappa and lambda)). |
| definition | string | no | the CDR definition, numbered in its own scheme (North in Chothia's). Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), north (North). |
| pH | number | no | the pH the net charge and the CDR charge are reported at. |
| _subject | object | 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. |
| _files | array | 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. |
Assign each CDR of an antibody heavy, kappa or lambda variable domain to its canonical structure class: SCALOP's length-independent clusters of known loop conformations (CDR-H1, H2, L1, L2, L3; H3 has no canonical classes). Each loop is scored against every cluster of its length by the cluster's position-specific log-odds; the best score above SCALOP's threshold names the class and its median stru
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (one-letter amino acids); every heavy, kappa and lambda variable domain in it is classified. |
| scheme | string | no | the numbering the clusters are read in. Values: imgt (IMGT), chothia (Chothia). |
| definition | string | no | where each CDR begins and ends, by SCALOP's own tables. Values: imgt (IMGT), chothia (Chothia), north (North). |
| species | array | no | species whose HMMs are preferred when numbering (ANARCI's default: human and mouse). |
| _subject | object | 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. |
| _files | array | 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. |
How common each residue of an antibody variable domain is at its IMGT position, and which residues are rarer there than a cut (abYsis's 1% "unusual residue" by default). Two distributions: IMGT's own germline V and J alleles of a species (one count per reference allele), or a bundled Observed Antibody Space repertoire subset (one count per unique expressed sequence; human naive B cells, Jaffe et a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence (one-letter amino acids); every antibody and T-cell-receptor variable domain in it is read. |
| distribution | string | no | what each position is counted over: germline (IMGT's V and J alleles of germline_species) or repertoire (the bundled human OAS subset of expressed sequences). |
| germline_species | string | no | the species whose IMGT germline alleles each position is counted over (germline distribution only; the repertoire is human). |
| rare_below | number | no | a residue is rare where its share of the alleles or sequences is below this fraction (abYsis's unusual-residue cut is 0.01). |
| species | array | no | species whose HMMs are preferred when numbering (ANARCI's default: human and mouse). |
| _subject | object | 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. |
| _files | array | 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. |
Per-site and per-sample genotype statistics of a call set, for all samples or one population: allele counts and frequencies, called and missing calls, heterozygous and homozygous counts, observed and expected heterozygosity and the inbreeding coefficient F (scikit-allel), and the exact Hardy–Weinberg test with its excess-heterozygosity tail (bcftools +fill-tags). Validated on every site and sample
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vcf | string | yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. |
| populations | string | no | a sample table: a header row with a sample column and one or more grouping columns (tab-separated, as 1000 Genomes' .panel). Samples it does not list belong to no group. |
| groupBy | string | no | which column of the sample table groups the samples; empty is its first grouping column. |
| group | string | no | compute over this group's samples only; empty is every sample. |
| _subject | object | 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. |
| _files | array | 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. |
Linkage disequilibrium between every pair of biallelic sites of a call set: the dosage correlation r of Rogers and Huff (scikit-allel), or haplotype r² and D′ from the maximum-likelihood two-locus haplotype frequencies (PLINK 1.9 --r2 dprime-signed), plus LD pruning by sliding windows (scikit-allel locate_unlinked). Validated on every pair of 1000 Genomes phase 3 APOL1 sites.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vcf | string | yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. |
| populations | string | no | a sample table: a header row with a sample column and one or more grouping columns (tab-separated, as 1000 Genomes' .panel). Samples it does not list belong to no group. |
| groupBy | string | no | which column of the sample table groups the samples; empty is its first grouping column. |
| group | string | no | compute over this group's samples only; empty is every sample. |
| estimator | string | no | rogersHuff: r between alt-allele dosages, no phasing (scikit-allel). haplotype: r² and D′ from the maximum-likelihood haplotype frequencies (PLINK 1.9). Values: rogersHuff (Rogers–Huff r (genotype dos |
| minMac | number | no | keep sites where REF and the first ALT are each seen at least this many times (scikit-allel is_biallelic_01 min_mac). |
| start | number | no | first position (1-based) of the window; 0 is the first site. |
| end | number | no | last position (1-based) of the window; 0 is the last site. |
| maxSites | number | no | refuse more sites than this: the pair count grows with its square. |
| pruneSize | number | no | LD pruning window, in sites (locate_unlinked size). |
| pruneStep | number | no | sites the pruning window advances (locate_unlinked step). |
| pruneThreshold | number | no | prune the later site of a pair whose Rogers–Huff r² exceeds this (locate_unlinked threshold). |
| _subject | object | 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. |
| _files | array | 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. |
Differentiation between populations of a call set: Weir and Cockerham's θ over two or more populations, or Hudson's or Patterson's Fst between pairs, per site and averaged with a block-jackknife standard error (scikit-allel). Every pair when more than two populations are compared. Validated on every site of 1000 Genomes phase 3 APOL1 for the 5 super-populations and 26 populations.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vcf | string | yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. |
| populations | string | yes | a sample table: a header row with a sample column and one or more grouping columns (tab-separated, as 1000 Genomes' .panel). Samples it does not list belong to no group. |
| groupBy | string | no | which column of the sample table groups the samples; empty is its first grouping column. |
| estimator | string | no | weirCockerham: θ from the variance components over every compared population at once. hudson: 1 − within / between pairwise differences (Bhatia 2013). patterson: F2-based, biallelic sites only. Values |
| compare | string | no | the populations to compare, comma-separated; empty is every group of the column. |
| blockLength | number | no | sites per jackknife block for the average's standard error; a trailing partial block is dropped, as scikit-allel does. |
| _subject | object | 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. |
| _files | array | 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. |
Principal components of a call set's genotypes, the population-structure picture: biallelic sites above a minor-allele count, LD-pruned by sliding windows, scaled per site (Patterson, standard or centring) and decomposed; every sample's coordinates with its population, and the variance each component explains (scikit-allel pca). Validated on 1000 Genomes phase 3 APOL1, all 2,504 samples.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vcf | string | yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. |
| populations | string | no | a sample table: a header row with a sample column and one or more grouping columns (tab-separated, as 1000 Genomes' .panel). Samples it does not list belong to no group. |
| groupBy | string | no | which column of the sample table groups the samples; empty is its first grouping column. |
| minMac | number | no | keep biallelic sites whose REF and first ALT are each seen at least this many times. |
| prune | boolean | no | drop sites in LD before the decomposition (locate_unlinked), as scikit-allel's PCA assumes. |
| pruneSize | number | no | pruning window, in sites. Only applies when prune is true. |
| pruneStep | number | no | sites the pruning window advances. Only applies when prune is true. |
| pruneThreshold | number | no | prune the later site of a pair whose Rogers–Huff r² exceeds this. Only applies when prune is true. |
| nComponents | number | no | components to report. |
| scaler | string | no | per-site scaling before the decomposition: Patterson divides the centred dosage by √(p(1−p)); standard by its standard deviation; center only centres. Values: patterson (Patterson (√(p(1−p)))), standa |
| precision | string | no | float64, or float16: scikit-allel's own path when handed integer genotypes, which rounds the scaled matrix to half precision. Values: float64 (Double precision), float16 (Half precision (as scikit-all |
| _subject | object | 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. |
| _files | array | 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. |
Individual ancestry coefficients, the ADMIXTURE-style picture: each sample as a mixture of K ancestral populations, fitted by sparse non-negative matrix factorisation for every K in a range, with K scored by the cross-entropy of predicting genotypes held out at random (LEA snmf, Frichot et al. 2014). Single-base records only, as LEA's vcf2geno keeps them. Validated against LEA 3.19.8 on every reco
| Parameter | Type | Required | Notes |
|---|---|---|---|
| vcf | string | yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. |
| populations | string | no | a sample table: a header row with a sample column and one or more grouping columns (tab-separated, as 1000 Genomes' .panel). Samples it does not list belong to no group. |
| groupBy | string | no | which column of the sample table groups the samples; empty is its first grouping column. |
| kFrom | number | no | smallest number of ancestral populations to fit. |
| kTo | number | no | largest number of ancestral populations to fit; every K from kFrom up is fitted, on one random stream. |
| holdOut | boolean | no | hold out a share of genotypes and score each K by the cross-entropy of predicting them; the K with the lowest is the one the data support best. |
| holdOutShare | number | no | share of genotypes held out for the cross-entropy. Only applies when holdOut is true. |
| alpha | number | no | regularisation added to every cell of FᵀF in the Q step: larger values push each sample toward fewer ancestries. Advanced. |
| tolerance | number | no | stop when the relative change in the least-squares criterion falls below this (after 16 passes). Advanced. |
| iterations | number | no | most alternating passes per K. Advanced. |
| ploidy | number | no | 2 for diploid ALT counts 0/1/2, 1 for haploid 0/1. Advanced. |
| seed | number | no | R's set.seed value: it fixes the held-out genotypes and every K's random start, so a run is reproducible and citable. |
| _subject | object | 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. |
| _files | array | 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. |
Differential expression from raw RNA-seq read counts, by one of the three standard count models. DESeq2 (Love, Huber & Anders 2014): median-of-ratios size factors, negative-binomial GLM with empirical-Bayes shrunken dispersions, Wald or likelihood-ratio test, Cook's-distance outlier handling, independent filtering, optional LFC shrinkage. edgeR quasi-likelihood (Chen et al. 2025): filterByExpr, TM
| Parameter | Type | Required | Notes |
|---|---|---|---|
| counts | string | yes | raw read counts (never normalized values or TPM): genes in rows with the gene ID first, samples in columns, tab- or comma-separated, a header row naming the samples. |
| samples | string | yes | the sample table: a header row, then one row per sample with its name (as in the count table's header) first and the design's variables after; the run uses this table's sample order. |
| method | string | no | the count model: DESeq2 (negative binomial, Wald or LRT), edgeR-QL (negative binomial with quasi-likelihood F-test) or limma-voom (precision-weighted linear model on log-CPM, moderated t). |
| design | string | no | the design formula over the sample table's columns, the variable of interest last (e.g. '~ batch + condition'). |
| reference | string | no | reference level per factor, 'variable=level' separated by commas; a factor not named takes its alphabetically first level, as R does. |
| test | string | no | Wald: one coefficient or contrast. LRT: the full design against reduced, testing every removed term at once. Only applies when method is DESeq2. |
| reduced | string | no | the reduced design for the likelihood-ratio test. Only applies when method is DESeq2. |
| contrast | string | no | 'factor, numerator, denominator': the log2 fold change of numerator over denominator. Empty is the design's last coefficient. Under edgeR and voom the denominator must be the factor's reference level. |
| name | string | no | one fitted coefficient to report, by its DESeq2 name (e.g. 'condition_treated_vs_untreated') or its model-matrix column ('conditiontreated'); empty is the last. |
| fitType | string | no | the dispersion trend: parametric (asymptDisp + extraPois / mean, DESeq2's default, which falls back to local when it does not fit), local (locfit regression of log dispersion on log mean), the mean of |
| sfType | string | no | size factors: median of ratios over genes with no zero (ratio), with zeros allowed (poscounts, for sparse data), or iterated to maximise the NB likelihood of all but the worst-fitting 5% of genes (ite |
| avgTxLength | string | no | optional: tximport's average transcript lengths (txi$length), the same genes and samples as counts. DESeq2 then normalizes by gene-by-sample factors (each gene's lengths over their geometric mean, t |
| weights | string | no | optional: observation weights (assays(dds)[["weights"]]), the same genes and samples as counts, e.g. zinbwave's posterior probability that a single-cell count is not a dropout. DESeq2 divides each g |
| useT | boolean | no | Wald p-values from a Student t on each gene's summed weights (or the sample count) minus the coefficients, instead of the normal: zinbwave's recommendation for weighted single-cell data. Wald test onl |
| minmu | number | no | the floor on fitted means in the GLM and the dispersion fit; empty is DESeq2's default, 0.5, or 1e-6 with fitType glmGamPoi. Single-cell counts, often below 1, want a small value such as 1e-6 (zinbwav |
| betaPrior | boolean | no | DESeq2's pre-1.16 default: a zero-mean Normal prior on every level's log2 fold change, so the reported fold changes, SEs and Wald test are the shrunken (MAP) ones. Wald only, no interactions; use inst |
| alpha | number | no | the target FDR: the summary counts genes below this adjusted p, and DESeq2's independent filtering maximizes rejections at it. |
| filterByExpr | boolean | no | keep only genes edgeR's filterByExpr finds expressed (the edgeR and limma workflows' first step); off fits every gene. Only applies when method is edgeR-QL or limma-voom. |
| minCount | number | no | filterByExpr: the count, at the median library size, a gene needs in the smallest group's worth of samples (taken as CPM). Only applies when method is edgeR-QL or limma-voom. |
| minTotalCount | number | no | filterByExpr: the total count a gene needs across all samples. Only applies when method is edgeR-QL or limma-voom. |
Over-representation analysis (ORA): which gene sets hold more of a gene list than chance, by the one-sided hypergeometric test against a background, as clusterProfiler's enricher() runs it (enrichit 0.2.6). Reports gene and background ratios, fold enrichment, odds ratio, z-score, p, adjusted p and Storey q-value per set, and which sets pass both cutoffs. Every tested set is bit-identical to enrich
| Parameter | Type | Required | Notes |
|---|---|---|---|
| genes | string | yes | the gene list (e.g. the significant genes of a DE run), one ID per line or separated by commas or spaces. |
| geneSets | string | yes | the gene sets, as GMT text (MSigDB, GO or WikiPathways exports): one set per line, tab-separated ID, description, then member gene IDs. IDs must be the same kind as the genes'. |
| universe | string | no | the background: every gene the experiment could have called (e.g. a DE run's tested genes). Empty is every gene any set annotates, clusterProfiler's default. |
| forceUniverse | boolean | no | use universe as given instead of intersecting it with the annotated genes. |
| weights | string | no | per-gene sampling weights, 'gene weight' per line (e.g. a DESeq2 run's mean normalized counts, meanCounts, or gene lengths): replaces the hypergeometric test with Wallenius' noncentral one (BiasedUr |
| minGSSize | number | no | smallest set tested, counted within the background. |
| maxGSSize | number | no | largest set tested, counted within the background. |
| pAdjustMethod | string | no | multiple-testing adjustment across the tested sets (R p.adjust). |
| pvalueCutoff | number | no | a set is enriched when p and adjusted p are at most this. |
| qvalueCutoff | number | no | and its q-value at most this. |
| _subject | object | 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. |
| _files | array | 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. |
Preranked gene set enrichment analysis (GSEA; Subramanian et al. 2005) with fgsea's multilevel p-values (Korotkevich et al.), either as clusterProfiler's GSEA() runs it (enrichit 0.2.6, with q-values; or its fixed-count or adaptive sample and permute tests) or as fgsea 1.38 itself runs it (fgseaMultilevel, or fgseaSimple with a permutation count): weighted running-sum enrichment score, normalized
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ranked | string | yes | the ranked list: 'gene statistic' per line (tab, comma or space), e.g. a DE run's Wald statistic; sorted decreasing here if it is not. |
| geneSets | string | yes | the gene sets, as GMT text (MSigDB, GO or WikiPathways exports): one set per line, tab-separated ID, description, then member gene IDs. IDs must be the same kind as the genes'. |
| minGSSize | number | no | smallest set tested, counted among the ranked genes. |
| maxGSSize | number | no | largest set tested, counted among the ranked genes. |
| exponent | number | no | weight of each gene's statistic in the running sum: 0 is the unweighted Kolmogorov-Smirnov form, 1 classic GSEA. |
| scoreType | string | no | std: both tails; pos or neg: one-tailed, for a statistic with one meaningful sign (the multilevel estimate only). Only applies when method is multilevel. |
| eps | number | no | floor for multilevel p-values; 0 estimates them however small. Only applies when method is multilevel. |
| sampleSize | number | no | multilevel samples per level (made odd). Only applies when method is multilevel. |
| nPermSimple | number | no | multilevel: permutations for the first, simple p-value estimate and the NES. Only applies when method is multilevel. |
| seed | number | no | seeds the permutations; the same seed gives the same p-values as the chosen engine in R (fgsea: set.seed(seed) before the call). |
| engine | string | no | clusterProfiler: enrichit 0.2.6's GSEA, what clusterProfiler 4.20's GSEA() runs, with q-values. fgsea: fgsea 1.38's own, a different random stream and arithmetic, so the same seed gives fgsea's p-valu |
| nperm | number | no | fgsea: run fgseaSimple with this many permutations (p-values no smaller than 1/(nperm + 1)); 0 keeps the multilevel estimate. Only applies when engine is fgsea. |
| method | string | no | clusterProfiler's p-value: multilevel Monte Carlo (fgsea-derived, down to eps); sample: a fixed count of random gene samples of each set's size; permute: that count of relabellings of the whole ranked |
| permutations | number | no | sample or permute: null draws per set (p-values no smaller than 1/(same-side draws + 1)). Only applies when method is sample or permute. |
| adaptive | boolean | no | sample or permute: draw per set in batches from minPerm, doubling while its p-value is at most pvalThreshold, up to maxPerm, instead of a fixed count. Only applies when method is sample or permute. |
| minPerm | number | no | adaptive: the first batch for every set. Only applies when adaptive is true. |
| maxPerm | number | no | adaptive: the most draws any set gets. Only applies when adaptive is true. |
| pvalThreshold | number | no | adaptive: a set whose p-value rises above this stops drawing. Only applies when adaptive is true. |
| pAdjustMethod | string | no | multiple-testing adjustment across the tested sets (R p.adjust). |
| pvalueCutoff | number | no | a set is significant when p and adjusted p are at most this. |
Competitive gene set test that accounts for inter-gene correlation (camera; Wu & Smyth 2012), as limma 3.68.5 runs it: is a set more differentially expressed than the genes outside it, with the variance of its mean statistic inflated by the correlation between its genes instead of treating them as independent. From a count table it fits voom (filterByExpr, TMM, precision weights) and tests the des
| Parameter | Type | Required | Notes |
|---|---|---|---|
| statistic | string | no | ranked: cameraPR on a supplied gene-wise statistic (ranked). voom: camera on a voom fit of counts and samples, each gene's own residuals and weights. Given only counts, voom is assumed. |
| ranked | string | no | a gene-wise statistic, 'gene statistic' per line (e.g. a DE run's Wald or moderated t). Only applies when statistic is ranked. |
| counts | string | no | a gene-by-sample table of raw read counts, gene IDs in the first column: camera then runs on its voom fit (filterByExpr, TMM, voom weights). Give this or ranked. Only applies when statistic is voom. |
| samples | string | no | with counts: one row per sample, its name first, then the design's variables. Only applies when statistic is voom. |
| design | string | no | with counts: the design formula, the variable of interest last. Only applies when statistic is voom. |
| reference | string | no | reference level per factor, 'variable=level' separated by commas; a factor not named takes its alphabetically first level. Only applies when statistic is voom. |
| name | string | no | the tested coefficient by name; empty is the design's last. Only applies when statistic is voom. |
| contrast | string | no | 'factor, numerator, denominator', the denominator being the factor's reference level. Only applies when statistic is voom. |
| filterByExpr | boolean | no | drop genes too lowly expressed to test (edgeR's filterByExpr) before voom. Only applies when statistic is voom. |
| minCount | number | no | filterByExpr: minimum count in the smallest group's worth of samples. Only applies when statistic is voom. |
| minTotalCount | number | no | filterByExpr: minimum total count. Only applies when statistic is voom. |
| geneSets | string | yes | the gene sets, as GMT text (MSigDB, GO or WikiPathways exports): one set per line, tab-separated ID, description, then member gene IDs. IDs must be the same kind as the genes'. |
| useRanks | boolean | no | a correlation-adjusted Wilcoxon rank-sum test instead of the parametric t on z-scores; robust to a few extreme genes. |
| interGeneCor | number | no | the fixed inter-gene correlation, limma's default 0.01 (a value most real sets exceed slightly). |
| estimateCorrelation | boolean | no | with counts: estimate each set's correlation from the residuals instead of fixing it; the test then uses min(residual df, genes - 2) degrees of freedom. Only applies when statistic is voom. |
| allowNegCor | boolean | no | with an estimated correlation: let a negative estimate deflate the variance (limma floors it at 0). Only applies when statistic is voom. |
| directional | boolean | no | test up or down against the rest (true), or only whether the set's genes change more in either direction (false, a rank test on |statistic|). |
| fdrCutoff | number | no | a set is called when its BH FDR (its p-value when one set is tested) is at most this. |
| _subject | object | 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. |
| _files | array | 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. |
Sweep a set of sequences against every exact recognition site in the NEB catalog and report the sites each one carries far less (avoided) or far more (enriched) often than a stated null predicts, with the false discovery rate controlled across every (sequence, site) test. Avoidance is evidence of the restriction–modification systems a lineage has lived with, and a site a design can rely on being r
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequences | array | no | the corpus: wire upstream records here, or list library document names. Each is one record of the sweep. |
| include_subject | boolean | no | also sweep the node's subject (the open or wired record). |
| enzymes | array | no | restrict the sweep to these enzymes' sites (NEB names). Empty sweeps every exact site in the catalog; degenerate (IUPAC) sites are never swept and are listed in the result. Advanced. |
| min_site_length | number | no | shortest recognition site swept. In bp. |
| alpha | number | no | false discovery rate at which a site is reported avoided or enriched. |
| correction | string | no | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence, including overlapping sites on one sequence; less power). Values: BH (Benjamini–Hochberg), BY (Be |
| null_model | string | no | what a site is rare relative to: base composition, shuffles that keep the record's own k-let counts, or the record's own (k−1)-mers for a site of length k (R'MES maximal order, Gaussian score). Values |
| shuffle_k | number | no | k-let size the shuffles preserve. 2 holds every dinucleotide count, so CpG depletion is in the null. Only applies when null_model is shuffle. |
| shuffles | number | no | shuffles per record. The smallest p the null can give is 1 / (shuffles + 1). Only applies when null_model is shuffle. |
| seed | number | no | seed for the shuffles, so a run reproduces. Only applies when null_model is shuffle. Advanced. |
| positions | boolean | no | also return every occurrence's coordinate and strand, for drawing on a map. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Score every coding sequence of a genome against the genome's own codon usage and report the genes whose synonymous codon choice that average does not explain, with the false discovery rate controlled across the genes. Records from different files are different genomes: each is scored against its own file's usage, and the false discovery rate is controlled once across every gene of every genome. Ea
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequences | array | no | the genomes' coding sequences: wire upstream records here, or list library document names (each record of a CDS FASTA is one gene, read in frame from its first base; each file is one genome). |
| genetic_code | number | no | NCBI genetic code the genes are read with (4 for Mycoplasma, 11 for most bacteria; 1 and 11 group codons identically). Values: 1 (1 · Standard), 2 (2 · Vertebrate Mitochondrial), 3 (3 · Yeast Mitochon |
| min_codons | number | no | genes with no more codons than this leave the reference and the result: the G-test's χ² limit is poor for short genes. In codons. |
| alpha | number | no | false discovery rate at which a gene is reported as an outlier. |
| correction | string | no | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). |
| file_codes | array | no | a genetic code for one file, as file=code (e.g. Mycoplasma_genitalium_cds.fna=4): that file's genes are read with it, every other file with genetic_code. For a corpus whose genomes translate diffe |
| pool_files | boolean | no | score every named record as ONE genome, for a genome split across files (one per chromosome). Off: each file is its own genome, scored against its own usage. |
| alt_init | boolean | no | count every alternative start codon as Met throughout each gene, as coRdon does by default. Off reads an internal alternative start codon as its own amino acid. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Ask whether some loci of a multi-locus alignment have a different history from the rest, by the incongruence length difference test (Farris et al. 1994). Each locus is one aligned FASTA file (or a set of wired alignment rows) over the same taxa, named alike in every file. D is the extra parsimony steps one shared tree costs over each locus's own tree; the null deals the same columns into parts of
| Parameter | Type | Required | Notes |
|---|---|---|---|
| loci | array | yes | the loci: one aligned FASTA file per locus (its records are the taxa), or library document names. Every file must name the same taxa. |
| permutations | number | no | random deals of the columns per test. The smallest p is 1 / (permutations + 1), which bounds how small a corrected q can get. |
| alpha | number | no | false discovery rate at which a locus is called. |
| correction | string | no | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). |
| seed | number | no | seed for the column deals. Each permutation draws from its own stream, so one can be re-run alone. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Ask whether a reference-gene stability ranking holds across conditions, and which candidate genes rank well everywhere rather than in one tissue or treatment. Each condition (the Group column of a long-format Cq table) is ranked by geNorm on its own samples; the conditions are then the blocks of a Friedman test and Kendall's W says how far they agree (0 independent orders, 1 the same order everywh
| Parameter | Type | Required | Notes |
|---|---|---|---|
| cq_table | string | yes | the long-format table Target,Sample,Group,Cq, one row per measurement; Group is the condition each sample was measured in, and every gene must be measured in every sample. |
| permutations | number | no | shuffles of the ranks within each condition. The smallest p is 1 / (permutations + 1). |
| seed | number | no | seed for the shuffles. Each permutation draws from its own stream, so one can be re-run alone. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Test a hypothesis that a gene drives a phenotype ("gene G regulates IL-2 production") the way POPPER does: each evidence table is one falsification test, an implication of the hypothesis that a gene-level score could contradict (expression in the relevant tissue, association with related disease, interaction with genes annotated to the process). Under the null that G is exchangeable with any gene
| Parameter | Type | Required | Notes |
|---|---|---|---|
| gene | string | yes | the gene under test, as the tables spell it (HGNC symbol for the bundled corpus). |
| tables | array | yes | the falsification tests in the order to apply them: each { name, text, direction }, where text is gene<TAB>score with a header line and direction is the end of the score the hypothesis predict |
| alpha | number | no | the hypothesis passes when the product of e-values exceeds 1/α. |
| kappa | number | no | κ of the p-to-e calibrator κ·p^(κ−1); POPPER's default is 0.5. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Measure how often a corpus of maps carries a cryptic σ70 promoter, a cryptic splice site or a synthesis-breaking repeat MORE EXTREME THAN CHANCE, rather than how many it carries. Every map of a few kilobases spells promoters, splice donors and repeats, so a raw hit count measures length and composition; here each map's own extreme (its most negative promoter ΔG, its highest MaxEntScan donor and ac
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequences | array | no | the corpus: wire upstream records here, or list library document names. Each is one record of the sweep. |
| include_subject | boolean | no | also test the node's subject (the open or wired record). |
| flags | array | no | which statistics to run. Empty runs all seven. |
| alpha | number | no | false discovery rate at which a record counts towards a flag's rate. |
| correction | string | no | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). |
| shuffle_k | number | no | k-let size the shuffles preserve. 2 holds every dinucleotide count, which is what all three statistics read. |
| shuffles | number | no | shuffles per record. The smallest p the null can give is 1 / (shuffles + 1), which is what bounds how small a corrected q can get. |
| seed | number | no | seed for the shuffles. Each record draws from seed + its own index, so a record's answer does not depend on the rest of the corpus. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Find the genes whose own alignment rejects the species tree. Each named alignment file is one gene, its records the taxa, named as the species tree's tips. For every gene the species tree and each of its nearest-neighbour rearrangements (two per internal branch) is fitted by maximum likelihood under GTR + Γ (rates, base frequencies and shape fitted on the species tree, branch lengths refitted on e
| Parameter | Type | Required | Notes |
|---|---|---|---|
| alignments | array | yes | the gene alignments: library file names, each an aligned multi-FASTA with one record per taxon, the record names being the species tree's tips. |
| species_tree | string | yes | the species tree in Newick, tips named as the alignments' records. Rooted or not; it is tested unrooted. |
| alpha | number | no | false discovery rate at which a gene counts as rejecting the species tree. |
| correction | string | no | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). |
| replicates | number | no | RELL bootstrap replicates of the SH test. The smallest nonzero p is 1 / replicates; a p of 0 means no replicate reached the observed difference, which evidence reads as 1 / (replicates + 1). |
| sh_form | string | no | how each replicate is measured: from its best tree, as Shimodaira and Hasegawa (1999) and Goldman et al. (2000) define the test, or from its worst, as phangorn's SH.test computes it. They agree when t |
| gamma_categories | number | no | discrete Gamma rate categories; 1 fits no rate variation among sites. Advanced. |
| seed | number | no | seed for the bootstrap. Each gene draws from seed + its own index, so a gene's p does not depend on the rest of the corpus. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Check a published PCR or sequencing assay against the sequences that are circulating now: for each oligo, where its best binding site is in each genome, how many positions mismatch, and whether a mismatch sits in the 3′ end a polymerase has to extend through. It answers the question an assay's age raises — the design was made against the genomes available on the day, and the target has drifted und
| Parameter | Type | Required | Notes |
|---|---|---|---|
| assay | string | no | what the assay is called, for the result to name. |
| primers | array | no | the assay's primers, 5′→3′, IUPAC allowed. Written name=SEQUENCE to carry the published name. |
| probes | array | no | the assay's probes, 5′→3′. Scored the same way but with no 3′-end rule: a probe is not extended. |
| sequences | array | yes | the genomes to check against: wire upstream records here, or list library document names. |
| include_subject | boolean | no | also check the node's subject (the open or wired record). |
| three_prime_window | number | no | how many bases from a primer's 3′ end count as its 3′ end. 5 is the window Primer-BLAST's own specificity rule uses. In bp. |
| _subject | object | 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. |
| _files | array | 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. |
Check every annotated CDS of one or more GenBank maps against its own bases and genetic code: a frame that does not close (frameshift), a stop inside the reading frame, a first codon the code cannot start with, a last codon that is not a stop, and a /translation the bases do not give. A partial end (< or >) is not judged, and a /pseudo CDS carries no flag. Where an annotation ends without a stop i
| Parameter | Type | Required | Notes |
|---|---|---|---|
| genbank | array | yes | the GenBank files' contents, one string per file (a file may hold several records). |
| _subject | object | 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. |
| _files | array | 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. |
Put a hypothesis of the form "gene G is involved in trait T" through POPPER-style sequential falsification on two public tables, each test fixed in advance and run in a fixed order. (1) GTEx v8 expression: either G's co-expression across the 54 tissues with the trait's own gene(s), such as IL2 for IL-2 production, or G's expression in named tissues against its own elsewhere. (2) The GWAS Catalog:
| Parameter | Type | Required | Notes |
|---|---|---|---|
| gene | string | yes | the hypothesis gene, as its current HGNC symbol (protein-coding). |
| expression_test | string | no | which GTEx test: co-expression with the trait's own gene(s), or expression in named tissues against the gene's own elsewhere. One only, because both read GTEx and one table is one piece of evidence. V |
| trait_genes | array | no | co-expression: the trait's own gene(s) as HGNC symbols, such as IL2 for IL-2 production. |
| tissues | array | no | tissue test: GTEx tissue names where involvement implies higher expression, such as Whole Blood or Spleen. |
| categories | array | yes | GWAS Catalog parent categories an involved gene's associations should fall in, such as Immune system disorder. |
| alpha | number | no | the level the sequential test stops and decides at: supported when the product of e-values exceeds 1/α. |
| kappa | number | no | κ of the p-to-e calibrator e = κ·p^(κ−1). Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Ask whether the genes used to normalize expression (reference or housekeeping genes, such as GAPDH, ACTB or B2M) are more or less variable across human tissues than genes of the same abundance, on GTEx v8 median expression. Each candidate's standard deviation of log2(TPM + pseudocount) across the chosen tissues is ranked among the genes nearest it in mean expression (1,000 by default, from the 19,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| genes | array | yes | the candidate reference genes, as current HGNC symbols (GAPD is GAPDH). |
| tissues | array | no | GTEx tissue names to compare across, three or more; empty means all 54. |
| neighbours | number | no | how many genes nearest in mean expression each candidate is ranked among. The smallest p it can give is 1 / (neighbours + 1). |
| alpha | number | no | false discovery rate at which a candidate is called more variable, or steadier, than its peers. |
| correction | string | no | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). |
| pseudocount | number | no | added to TPM before the logarithm, so a tissue with no expression has one. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Find the signal peptides or transmembrane segments in reviewed human UniProt that a sequence predictor contradicts. Each feature backed by experiment (evidence code ECO:0000269) is scored to say what a confirmed feature looks like to the predictor; every other feature, annotated from similarity, sequence analysis or a rule, is ranked among those scores, and its conformal p-value (1 + experimental
| Parameter | Type | Required | Notes |
|---|---|---|---|
| feature | string | no | which annotation to test: signal peptides or transmembrane segments. Values: signal (Signal peptides), transmembrane (Transmembrane segments). |
| predictor | string | no | signal only: von Heijne's matrix asks whether signal peptidase would cut where UniProt says; DeepSig asks whether the protein has a signal peptide at all (it loads 9.8 MB of network weights and runs t |
| alpha | number | no | false discovery rate at which an annotation is called contradicted. |
| correction | string | no | Benjamini–Hochberg (independent or positively dependent tests; conformal p-values against one calibration set are positively dependent) or Benjamini–Yekutieli (any dependence; less power). Values: BH |
| decoding | string | no | transmembrane only: which HMM-TM decoder labels the residues. N-best is left out: it takes minutes per long protein, and the corpus has 5,231. Values: viterbi (Viterbi), posterior-viterbi (Posterior-V |
| _subject | object | 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. |
| _files | array | 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. |
Rank candidate experiments by what running them would TEACH — Lindley's expected information gain, the drop in uncertainty about a hypothesis expected before anything is run. Three grains: tests ranks candidate falsification tests against the beliefs a discovery ledger holds, each with the posterior its two outcomes would leave, by gain and separately by gain per unit cost; measurements says w
| Parameter | Type | Required | Notes |
|---|---|---|---|
| mode | string | no | which grain of the question: rank candidate tests, size a run of measurements, or size a run of trials. Values: tests (Candidate tests), measurements (Measurements of a mean), trials (Trials of a rate |
| tests | array | no | the candidates, each {id, hypothesis, power, alpha} and optionally cost, reads (what it would read) and label. Only applies when mode is tests. |
| ledger | object | no | a jane.discovery-ledger file, as run_discovery_programme returns: its elicited beliefs and the sources its evidence already read. Only applies when mode is tests. |
| beliefs | object | no | belief that each hypothesis is true, as {hypothesisId: probability} — given directly, or to override the ledger's. Only applies when mode is tests. |
| prior_sd | number | no | how uncertain the mean is now, as a standard deviation. Only applies when mode is measurements. |
| noise_sd | number | no | the measurement noise, in the same units. Only applies when mode is measurements. |
| n | number | no | how many measurements the run would take. Only applies when mode is measurements. |
| target_bits | number | no | a gain to reach: the answer says how many measurements it would take. Only applies when mode is measurements. |
| alpha | number | no | the Beta prior's α — successes already believed in. Only applies when mode is trials. |
| beta | number | no | the Beta prior's β — failures already believed in. Only applies when mode is trials. |
| trials | number | no | how many trials the run would take. Only applies when mode is trials. |
| _subject | object | 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. |
| _files | array | 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. |
The design step's view of a discovery corpus: each record's name, file, length and GC fraction, and how many records each file holds. Runs no test and returns no statistic, so hypotheses proposed from it are proposed before any result is seen (POPPER's metadata-only design step). Use it before run_discovery_programme.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequences | array | no | the corpus: library document or file names, or wired records. |
| _subject | object | 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. |
| _files | array | 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. |
Run a discovery program end to end under pre-registration: every hypothesis names its test (discover_site_avoidance: a site, optionally a record, and its null; discover_codon_outliers: a gene and its genetic code; validate_gene_trait: a human gene, the trait's own gene or tissues, and GWAS Catalog categories; discover_flag_rates: a cryptic-element flag, optionally a record, against k-let shuffles;
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequences | array | no | the corpus every registered test runs over: library document or file names, or wired records. |
| hypotheses | array | no | each {statement, test, params, direction, prior_belief?}. test: discover_site_avoidance (params site, record?, null_model, shuffle_k/shuffles/seed under the shuffle null; direction less, greater or tw |
| ledger | object | no | a ledger file from an earlier run, to continue: its hypotheses keep their evidence and new ones are added beside them. |
| run | object | no | a run file from an earlier call, to continue it: its seal and its pinned inputs are checked, hypotheses whose test failed or was deferred are retried, new ones are added, and nothing answered is run a |
| budget_seconds | number | no | seconds this call may spend running tests: whole tests run until the budget is spent and the rest are deferred, so a long program returns before a client's timeout and resume_research_run continues it |
| posterior_beliefs | array | no | each {id, samples}: the proposer's belief in a hypothesis after reading its evidence. With prior beliefs these give the follow-up order by Bayesian surprise. |
| alpha | number | no | e-BH level the verdicts are decided at, across every hypothesis in the ledger. |
| kappa | number | no | κ of the p-to-e calibrator e = κ·p^(κ−1); fixed for a ledger once it holds evidence. Advanced. |
| organism | string | no | the organism the corpus is from, for the literature query each supported hypothesis needs. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Read a research run file without running anything: whether its seal holds (an edited or truncated file is refused), every hypothesis's verdict and the rule its evidence was merged by, which hypotheses a resume would run (no evidence, and the last attempt failed or was deferred by a call's budget) and which are settled or canceled, and what resuming would do. Given the corpus, also reports every pi
| Parameter | Type | Required | Notes |
|---|---|---|---|
| run | object | yes | the run file run_discovery_programme or resume_research_run returned. |
| sequences | array | no | optionally, the corpus as it is now, to check against the run's pinned inputs. |
| _subject | object | 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. |
| _files | array | 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. |
List research runs without running anything: the runs this project holds (in the app), or the run files given (runs, which is how an HTTP or MCP caller lists the files it kept). For each run: whether its seal holds, its id, how many hypotheses it registered and how many are supported, not supported or without evidence, how many a resume would run, how many inputs it pins, and what resuming would
| Parameter | Type | Required | Notes |
|---|---|---|---|
| runs | array | no | the run files to list; in the app, left unset, the research runs this project holds. |
| _subject | object | 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. |
| _files | array | 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. |
Continue a research run from its file after an interruption or a failed test: the seal is checked, every pinned input the corpus still holds must have the content it had (a changed file is refused by name), and only the hypotheses with no evidence whose last attempt failed or was deferred are run, each with the settings it was registered with. Answered, settled and canceled hypotheses are never ru
| Parameter | Type | Required | Notes |
|---|---|---|---|
| run | object | yes | the run file to continue. |
| sequences | array | no | the corpus the run was registered over: library document or file names, or wired records. |
| budget_seconds | number | no | seconds this call may spend running tests: whole tests run until the budget is spent and the rest are deferred, so a long program returns before a client's timeout and resume_research_run continues it |
| _subject | object | 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. |
| _files | array | 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. |
Withdraw a research run's pending hypotheses (all of them, or the ones named) so no resume runs them, and return the sealed run file. Nothing is deleted: a canceled hypothesis stays registered and still counts in e-BH with e 1, because it was registered before any result and dropping it would raise the others' chance of support after the fact. Answered and settled hypotheses cannot be canceled. To
| Parameter | Type | Required | Notes |
|---|---|---|---|
| run | object | yes | the run file to cancel pending hypotheses in. |
| hypotheses | array | no | the pending hypotheses to cancel, by id; unset cancels every pending one. |
| reason | string | no | why, recorded on each canceled attempt. |
| _subject | object | 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. |
| _files | array | 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. |
What can run next, and what each next step would add. Give it a tool whose run just finished (or the output types in hand) and it returns the tools whose own declared inputs those outputs fill, each with the parameter the wire lands on, the question that tool answers, its limits, what grades it, whether it is seeded, asynchronous, writing or leaving the machine, and which of the data files it read
| Parameter | Type | Required | Notes |
|---|---|---|---|
| after | string | no | the tool whose run just finished — its declared outputs are what is in hand. Leave unset and give output_types instead. |
| output_types | array | no | the port types in hand, when no single tool produced them (sequence, record, bands, sites, protocol, matrix, series). |
| target_type | string | no | optional: the output type you want to reach. Returns the shortest chains of tools that get there. |
| max_steps | number | no | longest chain to consider when a target_type is given. |
| independent_only | boolean | no | keep only steps that read none of the data files the finished run read, so each adds its own evidence. |
| read_only | boolean | no | keep only steps that write nothing. |
| _subject | object | 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. |
| _files | array | 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. |
Resolve one of your saved enzyme collections to the enzyme names in it, so a later step can scan, digest or design with 'my Golden Gate set' by name instead of whatever happens to be selected. Names the collection, says which of its enzymes the cut catalog can resolve and which it cannot, and — when a record is open — how many times each one cuts it. Left unnamed it answers for the collection that
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | the collection to resolve, by the name it has in the Enzyme Collections panel. Left unset, the active collection is used; with none active, the whole catalog is in scope and this says so rather than r |
| _subject | object | 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. |
| _files | array | 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. |
Your lab-notebook entries, newest first — id, title, tags, collection, when they changed, and the @plasmid / !action / &gel cross-references each one names. Filter by a tag, by collection, or by text in the title and body, so a run can find the entry it is continuing instead of starting a second one about the same experiment.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| search | string | no | match on title or body text, case-insensitively. Left unset, every entry is listed. |
| tag | string | no | only entries carrying this tag. |
| collection | string | no | only entries filed in this collection. |
| limit | number | no | how many entries to return, newest first. |
| _subject | object | 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. |
| _files | array | 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. |
Write what just happened into your lab notebook: a new entry, or more text appended to one you name. The body is markdown and its @plasmid / !action / &gel references are extracted as you write, so an entry made by a run is cross-linked exactly like one you typed — and carries the automated tag, so you can always tell which is which. Use it to end a pipeline with a record of itself instead of a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| title | string | no | the entry title. A new entry needs one. On an append, giving a title RENAMES the experiment, so leave it out to keep the name it has. |
| body_md | string | yes | the entry body, markdown. @plasmid-name, !action-id and &gel-id references in it are extracted into the entry's cross-reference lists, which is what makes a notebook searchable by construct. |
| entry_id | string | no | append to this entry instead of creating one — the id list_experiments returns. A pipeline that runs twice should append to its own entry rather than leaving two. |
| tags | array | no | tags to file it under, beyond the automated tag every entry written here carries. |
| collection | string | no | file it in this collection, creating the collection if it does not exist — the notebook's own grouping, the same one the panel lists. |
| _subject | object | 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. |
| _files | array | 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. |
Put a drawing that is on screen into the lab notebook as a numbered figure: a chart, gel, map or any other picture a tool drew on the stage. It is appended to the entry the user has open (or to the one you name), captioned with the drawing, the tool that drew it and what that tool concludes now, and numbered where it falls, exactly as the Export panel and a chart's own menu do it. Vector drawings
| Parameter | Type | Required | Notes |
|---|---|---|---|
| drawing | string | no | the drawing to take, by its name (a chart's title, e.g. "Melt curve"). Leave it out to take the first drawing of the tab. |
| tab | string | no | the stage tab or the tool surface id it shows (e.g. qpcr-curves). Leave it out for the tab the user is looking at. |
| entry_id | string | no | append to this entry instead of the open one; with neither, a new entry is started and named after the drawing. |
| caption | string | no | a caption to use instead of the generated one. Leave it out unless the user asked for wording: the generated caption names the drawing, the tool and its reading. |
| _subject | object | 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. |
| _files | array | 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. |
Save a set of enzymes as a named collection in your Enzyme Collections panel, so a scan that found the enzymes worth keeping ends by keeping them instead of asking you to retype the list. Every name is checked against the cut catalog first and an unknown one refuses the whole save by name, because a collection that silently lost two enzymes is worse than one that was never made. An existing collec
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | what to call the collection, as it will read in the panel. |
| enzymes | array | yes | the enzyme names to save — wire these from a scan (enzyme_cut_counts, digest_fragments) or from enzyme_collection rather than typing them, so the set is one the engine has already resolved. |
| replace | boolean | no | overwrite a collection that already has this name. Left false, a name clash refuses and says which collection it would have replaced. |
| activate | boolean | no | make it the active collection, which is what the panel does when you create one — every enzyme parameter that is left unset then scopes to it. |
| _subject | object | 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. |
| _files | array | 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. |
Remember what this lab uses, so the PCR program, primer design and codon optimization start on it: the polymerase, the primer length and GC windows, and the expression host. Use it when the user says what they use ("we use Q5", "our primers are 20 to 24 nt"). Saved where the user reads and edits it, Settings · Lab; each panel still says when it is showing the lab's choice, and a project can still
| Parameter | Type | Required | Notes |
|---|---|---|---|
| polymerase | string | no | the polymerase family the PCR program starts on, or keep to leave the saved one as it is. Values: keep (Keep as saved), taq (Taq), dbd (Phusion / Q5 (DNA-binding domain)). |
| polymerase_product | string | no | the cataloged product within that family, or generic for the preset alone. Values: generic (Generic preset (no datasheet)), takara-taq (Takara Bio · TaKaRa Taq / EmeraldAmp GT), takara-ex-taq (Takar |
| primer_length_min | number | no | shortest primer, nt. |
| primer_length_max | number | no | longest primer, nt. |
| primer_gc_min | number | no | lowest primer GC, %. |
| primer_gc_max | number | no | highest primer GC, %. |
| expression_host | string | no | the organism codon optimization targets: a scientific name or an NCBI taxonomy id. |
| clear | array | no | preferences to forget, so those panels start on their own defaults again. |
| _subject | object | 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. |
| _files | array | 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. |
Will the sequencer SEE these indexes? Per-cycle channel occupancy for a set of index sequences under an instrument's own SBS chemistry, checked against Illumina's rules (no dark cycle, both channels preferred, no GG in the first two cycles), each violation citing the vendor article it comes from — and the same set scored across EVERY chemistry generation at once, because XLEAP moved the dual-color
| Parameter | Type | Required | Notes |
|---|---|---|---|
| barcodes | array | yes | the index sequences to score, one per sample. |
| instrument | string | no | the instrument whose chemistry the set is judged under, and whose index-2 orientation applies. |
| _subject | object | 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. |
| _files | array | 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. |
Generate INDEL-correcting barcodes — FREE divergence codes (Hawkins et al., PNAS 2018) — by reserving each codeword's error sphere over the whole 4^k space, so the guarantee survives an insertion or deletion rather than only a substitution. Or prune a set you already own down to a valid FREE code, and see which members' decode spheres collided. This is a different construction from design_barcodes
| Parameter | Type | Required | Notes |
|---|---|---|---|
| mode | string | no | generate a new code, or prune an existing set down to a valid one. Values: generate (Generate a code), prune (Prune a set to a valid code). |
| length | number | no | barcode length k. The search is over the whole 4^k space, so cost rises steeply with it. |
| max_errors | number | no | how many insertions/deletions/substitutions each codeword must tolerate. Each extra error costs most of the code. |
| barcodes | array | no | the set to prune — required when mode is prune, ignored when generating. Only applies when mode is prune. |
| reserved | array | no | codewords already in use, whose decode spheres are claimed BEFORE generation — this is how a code is EXTENDED rather than regenerated, so what comes back is compatible with the indexes a lab already o |
| max_homopolymer | number | no | reject a candidate with a run of this many identical bases. 0 = no limit. Advanced. |
| max_gc | number | no | reject a candidate above this GC fraction. 0 = no limit. Advanced. |
| limit | number | no | stop after this many codewords. 0 = take the whole code. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Turn index sequences into the oligos a synthesiser makes: each index spliced between 5'/3' adapter arms, or onto a PCR primer in either orientation with an optional spacer. Audited for the problems that only exist once tag and oligo are concatenated and that no check of the index alone can see — a homopolymer run across the junction, a 5' tetramer recurring as its reverse complement, and an oligo
| Parameter | Type | Required | Notes |
|---|---|---|---|
| barcodes | array | yes | the index sequences to assemble. |
| format | string | no | adapter arms around the index, or a tagged PCR primer. Values: adapter (5'/3' adapter arms), primer (Tagged PCR primer). |
| adapter_5 | string | no | 5' arm the index is spliced after — the Illumina P5, and the panel's own default. |
| adapter_3 | string | no | 3' arm the index is spliced before — the TruSeq read-1 primer, and the panel's own default. |
| primer | string | no | the PCR primer the tag is appended to — required when format is primer. |
| spacer | string | no | bases between the tag and the primer. Heterogeneity/phasing spacers are routine on a low-diversity library. Advanced. |
| reverse_complement_tag | boolean | no | use each tag as its reverse complement, in an adapter or on a primer, as the instrument requires for some read orientations. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Will this pool of sample indexes actually sequence? One verdict over the indexes a lab is about to load: duplicates, uniform length, the distance the set really guarantees against the distance it claims, per-cycle color balance on the chosen instrument's own chemistry, the index-2 orientation that instrument reads, and index-hopping exposure — how many i7 x i5 combinations exist against how many a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| pool | string | no | the pool as text — one row per sample: name<TAB>i7[<TAB>i5], or bare index sequences one per line, with or without a header. Rows that cannot be read are REPORTED with their line number, never dropp |
| kit | string | no | a vendor kit id instead of a pasted list — the kit's own indexes are resolved and checked. Ignored when pool is given. Values: (No kit — paste a list instead), truseq-single-indexes (TruSeq Single |
| instrument | string | no | which instrument the run is on. It decides the chemistry the color balance is judged under AND the orientation index 2 is read in — a pool balanced on a NovaSeq 6000 is not balanced on a NovaSeq X. |
| metric | string | no | error model the distance guarantee is measured under — a pool safe under substitutions may be unsafe under indels. Values: hamming (Hamming (substitutions)), seqlev (Sequence-Levenshtein (indels)), le |
| i7_cycles | number | no | index-1 read length from the RUN RECIPE, when it differs from the index length — a 10 nt index read at 8 cycles is an 8 nt index for every purpose here. 0 = use the indexes' own length. |
| i5_cycles | number | no | index-2 read length from the run recipe. 0 = use the indexes' own length. |
| required_distance | number | no | the minimum distance the pool is SUPPOSED to guarantee, if it was designed to one — the check says whether it does. 0 = report the distance without judging it. Advanced. |
| library_prep | string | no | which of Illumina's published hopping-rate classes applies. The check multiplies the published RANGE by what this pool can throw away, to report how much is unrecoverable — it never predicts a rate fo |
| _subject | object | 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. |
| _files | array | 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. |
The melting temperature of an oligo IN A BUFFER, UNDER A MODEL — and the working, not just the number. Nearest-neighbor (SantaLucia & Hicks 2004 · Allawi & SantaLucia 1997 · Sugimoto 1996 · Breslauer 1986), pydna's dsDNA-binding-domain model, the GC formula, the Wallace rule or NEB, over the salt correction you name, then DMSO and formamide depression under the published model you name. LOCKED NUC
| Parameter | Type | Required | Notes |
|---|---|---|---|
| oligo | string | yes | the oligo to melt, 5'→3'. IUPAC ambiguity codes and whitespace are tolerated; at least 2 bases. An L after a base marks it LOCKED (LNA), e.g. GTCGLAACAGC — the marker is not a base and does not count |
| model | string | no | which melting model — nn_santalucia (Nearest-neighbor, SantaLucia 1997) · nn_unified (Nearest-neighbor, unified 2004) · nn_sugimoto (Nearest-neighbor, Sugimoto 1996) · nn_breslauer (Nearest-neighbor, |
| dmso_method | string | no | which published DMSO depression — ahs01 (Ahsen et al. (2001), 0.75 °C per %) · mus81 (Musielski et al. (1981), 0.6 °C per %) · cul76 (Cullen and Bick (1976), 0.5 °C per %) · esc80 (Escara and Hutton ( |
| conditions | object | no | the buffer this temperature is measured in: Na⁺/K⁺/Tris/Mg²⁺/dNTP under salt, the strand concentrations under oligo, and any DMSO or formamide under additives. Left unset it is filled from your |
| _subject | object | 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. |
| _files | array | 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. |
Protein → DNA: the coding sequence that would encode a protein, weighted by a real codon-usage table. Four rules — the host's most-frequent codon (EMBOSS backtranseq), a draw from the family's real frequency distribution, the IUPAC-degenerate consensus for primers/probes (EMBOSS backtranambig), or DnaChisel's table-free first codon. It does NOT optimize: for restriction-site avoidance, a GC target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence, one-letter codes (B/Z/J/U/O/X and gaps are handled and reported); wire it from translate_sequence. |
| strategy | string | no | mostFrequent — EMBOSS backtranseq, and SnapGene's “Preferred Codons”: every residue takes its host's single most-used codon. | weightedRandom — Each residue is drawn from its family's real frequency d |
| host | string | no | codon-usage table to weight by, named as the workbench knows it. Required for the two table-driven strategies and ignored by the other two. Tables loaded in the Back-translate or Optimizer panel this |
| table | string | no | genetic code the codons are chosen under. |
| append_stop | boolean | no | append a stop codon, chosen by the same strategy and table as every other codon. Skipped when the residues already end in *. |
| seed | number | no | seed for the usage-weighted draw, which makes a sampled design reproducible. Omit for an unseeded draw; ignored by the three deterministic rules. Only applies when strategy is weightedRandom. |
| _subject | object | 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. |
| _files | array | 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. |
Put the features from a GTF in this project onto the open record. A GTF lists features and their positions and carries no sequence, so this is how one reaches a molecule. It REFUSES unless something says the two are in the same coordinate space: if the file names a genome build and the record names the same one it proceeds; if they name different ones it refuses outright; if either is silent it re
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | the annotation file in this project, by name. Unset with exactly one present uses it; with several, this refuses and names them rather than picking. |
| sequence | string | no | the seqid within the file whose features to apply (a GTF names one per row). Unset with exactly one present uses it; with several, this refuses and names them — applying the wrong chromosome's interva |
| coordinates_only | boolean | no | state that you are applying the intervals as COORDINATES — positions in this record’s own numbering — with no genome correspondence checked. Applying coordinates on that basis is a claim about your ow |
| _subject | object | 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. |
| _files | array | 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. |
Find and name known features on the subject — vector parts, origins, resistance markers and tags — by exact match, by local alignment (which finds a diverged copy and reports the identity and coverage that earned it), or by both, on either strand and across the origin, plus Cre/loxP and Gateway att recognition sites. Emits an annotated record, so a downstream map or export carries the annotations.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| libraries | array | no | which feature corpora to search, by id (an id from annotation-library/manifest.json, or "legacy" for the unsourced set). Empty means the ones the panel starts with, which is every corpus but the two i |
| policy | string | no | what the emitted record does with the features it already had: merge keeps them all and skips a hit already there to the base, overwrite replaces a same-strand feature a hit overlaps, clear drop |
| lox_p | boolean | no | detect Cre/loxP-family recognition sites. |
| gateway | boolean | no | detect Gateway att recombination sites. |
| greedy_gateway | boolean | no | permissive att core matching — finds more sites, including partial ones. Only applies when gateway is true. Advanced. |
| mode | string | no | how to match a library entry: "exact" finds only a sequence spelled byte for byte, "alignment" finds a diverged copy and reports its identity and coverage, "both" runs each and keeps what only the oth |
| min_pi_per_match | number | no | lowest identity-weighted coverage worth reporting; upstream's own floor is 3, below which a hit is a fragment of a composite feature rather than the feature. Only applies when mode is alignment or bot |
| accepted_only | boolean | no | keep only hits clearing the corpus authority's own acceptance policy (>=95% identity, with a coverage bar that depends on the feature's length). Also decides overlaps: a hit the authority would reject |
| hide_fragments | boolean | no | hide hits covering under 95% of their database entry, which upstream calls fragments. Only applies when mode is alignment or both. Advanced. |
| max_expect | number | no | protein corpora only: the E-value a translated (six-frame) match must beat to be reported. It also sets the score the search runs at, so a stricter cutoff is a faster scan. Advanced. |
| min_identity | number | no | protein corpora only: drop a translated call under this percent identity over the residues aligned. Advanced. |
| min_coverage | number | no | protein corpora only: drop a translated call covering less than this much of the database protein's own length. Advanced. |
| alternatives | number | no | protein corpora only: how many runners-up to keep on each call, so a near relative is reported rather than implied. Advanced. |
| genetic_code | number | no | protein corpora only: the NCBI translation table the six frames are read under. 1 is the standard code. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Mask the parts of a sequence a similarity search should not seed on, using BLAST's own three maskers: DUST for compositionally biased DNA (poly-A, simple repeats), SEG for the protein equivalent, and WindowMasker for repeats that are ordinary in composition but occur far more often than chance allows in the sequences given. Emits the soft- and hard-masked sequences and the masked intervals, so a p
| Parameter | Type | Required | Notes |
|---|---|---|---|
| masker | string | no | which masker. dust and windowmasker take DNA; seg takes protein. Values: dust (DUST · biased DNA composition), seg (SEG · biased protein composition), windowmasker (WindowMasker · over-represented DNA |
| sequence | string | no | the sequence to mask. Wire a record or a sequence output, or paste it. Left empty, the open record is used. |
| context | array | no | WindowMasker only: the other sequences whose statistics define 'over-represented'. Its thresholds come from this SET, so wiring one plasmid asks whether a stretch is unusual for that plasmid, not for |
| level | number | no | DUST's T. Higher masks less. Only applies when masker is dust. |
| window | number | no | the scored window's width. 0 takes each masker's own default. |
| locut | number | no | SEG's K1, the trigger complexity in bits. Only applies when masker is seg. |
| hicut | number | no | SEG's K2, the extension complexity in bits. Only applies when masker is seg. |
| unit_size | number | no | WindowMasker's n-mer length. 0 derives it from the length of everything given, the way the tool does. Only applies when masker is windowmasker. |
| _subject | object | 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. |
| _files | array | 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. |
Screen a nucleotide sequence for vector, adapter, linker and primer contamination against NCBI's UniVec, using VecScreen's own BLASTn parameters and category rules. Reports every match graded Strong/Moderate/Weak plus the short 'suspect origin' stretches NCBI asks to be removed with the vector, and emits both the N-masked sequence and the longest clean region so a pipeline can gate on the result o
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the nucleotide sequence to screen; leave empty to screen the open record. A protein sequence is refused — this is a nucleotide search. |
| build | string | no | which UniVec build to search: 'core' is NCBI's curated 3,155-segment subset and is what routine screening should use; 'full' is the complete 6,111-segment set — more sensitive, and more redundant hits |
| reward | number | no | score for a matching base (-reward). Default is NCBI's published VecScreen setting; changing it means the result is no longer VecScreen's. Advanced. |
| penalty | number | no | score for a mismatching base, NEGATIVE (-penalty). With reward 1 and penalty −5 only a near-exact stretch can score above the reporting floor, which is what makes VecScreen specific. Default is NCBI |
| gap_open | number | no | cost to open a gap (-gapopen); a gap of length k costs gapopen + k * gapextend. Default is NCBI's published VecScreen setting; changing it means the result is no longer VecScreen's. Advanced. |
| gap_extend | number | no | cost per gapped base (-gapextend). Default is NCBI's published VecScreen setting; changing it means the result is no longer VecScreen's. Advanced. |
| word_size | number | no | exact-match seed length (-word_size). A sequence shorter than this cannot be screened at all, and the engine says so. Default is NCBI's published VecScreen setting; changing it means the result is n |
| x_drop_ungapped | number | no | X-drop for ungapped extension, in score units. It bounds extension; it does not change which alignment is optimal. Default is NCBI's published VecScreen setting; changing it means the result is no lon |
| x_drop_gapped | number | no | X-drop for the preliminary gapped pass, in score units (-xdrop_gap, converted); capped at each seed’s own ungapped score. Default is NCBI's published VecScreen setting; changing it means the result |
| x_drop_gapped_final | number | no | X-drop for the traceback that produces the reported alignment, in score units (-xdrop_gap_final, converted). Default is NCBI's published VecScreen setting; changing it means the result is no longer |
| ungapped_cutoff | number | no | lowest ungapped score that sends a seed to gapped extension — blastn’s gap trigger, converted from 27 bits. Default is NCBI's published VecScreen setting; changing it means the result is no longer Vec |
| min_score | number | no | lowest raw score worth reporting — VecScreen's weakest reportable match. Lowering it reports more and specifies less. Default is NCBI's published VecScreen setting; changing it means the result is no |
| dust | boolean | no | mask low-complexity sequence for SEEDING only (-dust yes -soft_masking true): a seed may not START in masked sequence, but an extension may run through it, so a genuine match spanning a repeat is no |
| terminal_strong | number | no | raw score at or above which a terminal match is graded Strong. A terminal match — one reaching within terminal_distance of an end of the query or of another reported region — is believed on less evi |
| terminal_moderate | number | no | raw score at or above which a terminal match is graded Moderate. Each ladder must stay in order (strong >= moderate >= weak) or the lower rungs become unreachable, and the run is refused rather than g |
| terminal_weak | number | no | raw score at or above which a terminal match is reported at all, as Weak. Below this a terminal match is not reported. Each ladder must stay in order (strong >= moderate >= weak) or the lower rungs be |
| internal_strong | number | no | raw score at or above which an internal match — one that is not terminal — is graded Strong. Each ladder must stay in order (strong >= moderate >= weak) or the lower rungs become unreachable, and the |
| internal_moderate | number | no | raw score at or above which an internal match is graded Moderate. Each ladder must stay in order (strong >= moderate >= weak) or the lower rungs become unreachable, and the run is refused rather than |
| internal_weak | number | no | raw score at or above which an internal match is reported at all, as Weak. NCBI leaves a deliberate gap here: an internal match scoring 16-22 is not reportable, because an internal match needs more ev |
| terminal_distance | number | no | how close to an end of the query — or to another reported region — a match must reach to count as terminal and be graded on the lower of the two ladders. NCBI's published value is 25 bases. Advanced. |
Frequency of optimal codons (Fop, Ikemura 1981) for an in-frame CDS against a real codon-usage table: what share of its codons are the ones a highly-expressed gene in that host would use. Where CAI scores how CLOSE each codon is to its family's best, Fop scores only whether it IS one of the best, which makes it comparable across genes of different amino-acid composition. Name a table this project
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the coding sequence, in frame (a length that is not a multiple of 3 is refused with the reason). Leave it empty to score the open record. |
| table | string | no | a codon-usage table this project holds, BY NAME, as the Codon Usage panel lists it — any organism. Takes precedence over host. This is the way to pass a table you fetched or built; host is only th |
| host | string | no | one of the three codon-usage tables bundled with the app. Only applies when table is not given. |
| threshold | number | no | Ikemura's optimality cutoff: a codon counts as optimal at this share of its family's most-used codon. 0.8 is the convention, not a measurement, and the right value is host-dependent. |
| _subject | object | 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. |
| _files | array | 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. |
Fetch a real codon-usage table for an organism and save it into this project, so later steps can score against it by name. NCBI builds the table by counting codons in the annotated CDS of a RefSeq assembly (the same counting the Codon Usage panel does, with the assembly and CDS count in the provenance); the Kazusa mirror serves a published table for an organism the mirror covers. The table LEAVES
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | 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. |
| organism | string | 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.built |
| mode | string | 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 org |
| coverage | string | 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 an |
| save_as | string | 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 | object | 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. |
| _files | array | 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. |
Run a sequence through EMBL-EBI's Job Dispatcher: Clustal Omega, MUSCLE, MAFFT, Kalign, T-Coffee, EMBOSS needle/water/matcher/stretcher, LALIGN, phmmer, hmmscan, PSI-BLAST or Phobius. These are the reference implementations a methods section names, so a local alignment can be checked against the tool the field actually cites. The sequences LEAVE THE MACHINE.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| service | string | no | which EBI service to run. Values: clustalo (Clustal Omega — HMM-profile progressive MSA), muscle (MUSCLE — Iterative refinement MSA), mafft (MAFFT — FFT-based progressive/iterative MSA), kalign (Kalig |
| sequences | array | no | the sequences to align. Wire records or sequence outputs, or paste FASTA. Multiple-alignment services take all of them; a pairwise service takes exactly two. |
| include_subject | boolean | no | include the record this step is running on as the first sequence. |
| stype | string | no | query alphabet, where the service takes one. Values: dna (nucleotide), protein (protein). |
| parameters | string | no | every other parameter the chosen service advertises, one id=value per line, using its own ids (matrix, gapopen, gapext, format, iterations…). Left empty each keeps the service's default. An id the s |
| string | no | EBI requires a contact address on every submission (their abuse contact, not a login). Left empty, the one saved in any EMBL-EBI panel is used. | |
| _subject | object | 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. |
| _files | array | 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. |
Search a sequence against NCBI BLAST+ at EMBL-EBI (blastn, blastp, blastx, tblastn or tblastx) over ENA, UniProtKB, PDB and the vector-screening sets. This is the similarity search a methods section cites: it turns an unnamed span into named homologues with E-values, and hands the hits, the tabular report and the job id downstream. The sequence LEAVES THE MACHINE.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| program | string | no | which BLAST program. The QUERY alphabet is derived from it and never asked for: blastx takes DNA and searches protein, tblastn the reverse. Values: blastn (blastn · dna query), blastp (blastp · protei |
| sequence | string | no | the query. Wire a record or a sequence output, or paste raw/FASTA. Left empty, the region below is taken from the open record. |
| region | string | no | which part of the open record to search, when no sequence is wired in. Values: whole (the whole record), selection (the current selection), feature (a named feature). |
| feature | string | no | the feature's name, matched case-insensitively on the open record. Only applies when region is feature. |
| databases | array | no | database ids to search, as the service names them (em_rel, uniprotkb, pdb, emvec…). Several are searched together. Left empty, the service's OWN default for this program's context is used and reported |
| parameters | string | no | every other advertised parameter, one id=value per line, using the service's own ids (exp, matrix, filter, gapopen, gapext, wordsize, alignments, scores, taxids…). Left empty each keeps the service' |
| string | no | EBI requires a contact address on every submission (their abuse contact, not a login). Left empty, the one saved in any EMBL-EBI panel is used. | |
| _subject | object | 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. |
| _files | array | 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. |
The Primer Designer's own ranked search: scan the open record for primer pairs inside a product-size, Tm, length and GC window, score every candidate on Tm, dimers, hairpins, 3' stability, repeats, clamp and specificity under weights you set, and return the best N. With task: existing, supply one primer and it designs the mate. Emits the top pair so a downstream pcr_amplify runs on it. For a seq
| Parameter | Type | Required | Notes |
|---|---|---|---|
| task | string | no | new ranks candidate pairs; existing keeps the primer you supply and designs its mate. |
| region_start | number | no | 0-based inclusive start of the region to design within. Unset = the whole template. Advanced. |
| region_end | number | no | 0-based inclusive end of the region to design within. Advanced. |
| target_start | number | no | 0-based inclusive start of a target the amplicon must flank, with no primer on it. Advanced. |
| target_end | number | no | 0-based inclusive end of the target. Advanced. |
| product_size_min | number | no | shortest acceptable amplicon. In bp. |
| product_size_max | number | no | longest acceptable amplicon. In bp. |
| target_tm | number | no | the Tm each primer is scored toward. In °C. |
| tm_window_min | number | no | lowest primer Tm accepted at all. In °C. |
| tm_window_max | number | no | highest primer Tm accepted at all. In °C. |
| primer_length_min | number | no | shortest primer. In nt. |
| primer_length_max | number | no | longest primer. In nt. |
| gc_min | number | no | lowest primer GC accepted. In %. |
| gc_max | number | no | highest primer GC accepted. In %. |
| n_pairs | number | no | how many ranked pairs to return. |
| mispriming_library | string | no | a Primer3 repeat library to screen every primer against. none skips the screen. Advanced. |
| existing_forward | string | no | with task: existing, the forward primer to keep. Only applies when task is existing. |
| existing_reverse | string | no | with task: existing, the reverse primer to keep. Only applies when task is existing. |
| fwd_tail | string | no | 5' non-annealing tail added to every forward primer (a restriction site or adapter). The footprint, and so binding and Tm, is unchanged. Advanced. |
| rev_tail | string | no | 5' non-annealing tail added to every reverse primer. Advanced. |
Find known SNPs under primers, the check NCBI Primer-BLAST makes with "Primer binding site may not contain known SNP". The template is placed on the UCSC assembly it was cut from, and the placement is proved by comparing the assembly's own sequence with the template; dbSNP 155 is then read over that span from the UCSC Genome Browser, and every primer is reported with the SNPs under it and each one
| Parameter | Type | Required | Notes |
|---|---|---|---|
| assembly | string | yes | the UCSC assembly id the template was cut from (hg38, mm39, danRer11…). |
| position | string | yes | where the template sits in that assembly, as chromosome:position, 1-based: the lowest assembly coordinate the template covers. The check finds which strand the template reads on itself. |
| snp_set | string | no | dbSnp155Common: About 15 million variants with a minor allele frequency of at least 1% in 1000 Genomes Phase 3. The default. dbSnp155: Every mapped variant: 1.06 billion locations on hg38, so few |
| pairs | array | no | the pairs to check, as design_primer_pairs' pairs output (each with forward and reverse start/end on the template). |
| forward | string | no | a forward primer to locate on the template by exact match, when no pairs are given. |
| reverse | string | no | a reverse primer to locate by exact match of its reverse complement. |
| template | string | no | the sequence the primers sit on. Left empty, the open record is used. |
| window_start | number | no | 1-based first base of the template span to check. Unset = the whole template. Advanced. |
| window_end | number | no | 1-based last base of the span to check. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Check primer pairs for products off their template, the way NCBI Primer-BLAST does, and rank them by it: each distinct primer is searched against a sequence database at EMBL-EBI with short-query BLAST, hits are paired into products by Primer-BLAST's own mismatch rule, and the template is searched too so the record identical to it is recognized as the intended target. Pairs with no product elsewher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| forward | string | no | one pair's forward primer, 5'→3' (wire design_primers' forward). |
| reverse | string | no | that pair's reverse primer, 5'→3' (wire design_primers' reverse). |
| pairs | string | no | several pairs to rank, one per line as forward reverse (whitespace or a comma between), in their design order. Taken instead of forward/reverse when given. |
| template | string | no | the sequence the pairs were designed on. Searched too: the database record identical to it is where the intended product lives. Left empty, the open record is used; with neither, every product counts |
| database | string | no | the nucleotide database id, as the service names it (em_all, em_rel_hum…). Left empty, the service's OWN nucleotide default is used and reported back. |
| top_n | number | no | how many of the pairs, from the top, to search. The rest rank as unchecked. At most 14, so the batch stays inside EMBL-EBI's 30 searches. |
| string | no | EBI requires a contact address on every submission (their abuse contact, not a login). Left empty, the one saved in any EMBL-EBI panel is used. | |
| _subject | object | 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. |
| _files | array | 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. |
Search a sequence against THIS PROJECT'S OWN records with blastn or blastp, on this machine: the local database is built from every project record of the program's alphabet, and every E-value is computed from that database's own size. Use it to ask which of my constructs, reads or proteins carry this span. Nothing leaves the machine; for public databases use blast_search.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| program | string | no | blastn searches the nucleotide records, blastp the protein records. Values: blastn (blastn · nucleotide query), blastp (blastp · protein query). |
| sequence | string | no | the query. Wire a record or a sequence output, or paste raw/FASTA. Left empty, the region below is taken from the open record. |
| region | string | no | which part of the open record to search, when no sequence is wired in. Values: whole (the whole record), selection (the current selection), feature (a named feature). |
| feature | string | no | the feature's name, matched case-insensitively on the open record. Only applies when region is feature. |
| maxExpect | number | no | E-value cutoff (BLAST+'s -evalue); hits above it are not reported. |
| _subject | object | 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. |
| _files | array | 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. |
Resolve an organism to its published genome assemblies and the chromosomes, plasmids and organelles each one is made of, with every accession and length NCBI reports. This is how a pipeline starts from a SPECIES rather than from an accession somebody looked up by hand: hand the replicon accession it returns to fetch_record, with a region, to pull a window of that chromosome. Assemblies come back r
| Parameter | Type | Required | Notes |
|---|---|---|---|
| organism | string | yes | a scientific name, a common name, or a taxonomy id (NCBI Datasets accepts all three). "Escherichia coli", "human", "559292" are all valid. |
| assembly | string | no | an assembly accession to take the replicons of, instead of this organism's top one. Use it to pin a pipeline to one genome build rather than to whatever is reference today. |
| replicons | boolean | no | list the chosen assembly's assembled molecules too. Off costs one request and answers 'which assemblies exist'; on costs two and answers 'which chromosome do I fetch'. |
| _subject | object | 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. |
| _files | array | 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. |
Search the sequence archives by free text (a gene name, a protein, an organism, a phrase) across NCBI Nucleotide and Protein, ENA (plain records, WGS and TSA/TLS assembly sets, and annotated coding/non-coding features), UniProtKB and the iGEM Registry at once, and hand back the matching accessions. This is the half of Fetch from database that answers "which record do I want?"; fetch_record answers
| Parameter | Type | Required | Notes |
|---|---|---|---|
| query | string | yes | the words to search for. Archive query syntax is accepted where the archive accepts it, but plain words are the normal case: "beta-lactamase Escherichia coli", "GFP", "pUC19". |
| sources | array | no | which archives to ask. Each is searched independently and the hits are interleaved, so asking more costs time rather than accuracy. Defaults to the nucleotide pair the panel opens on. |
| limit | number | no | how many hits to ask each source for. The panel pages at this size, and every source is asked for the same number. |
| _subject | object | 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. |
| _files | array | 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. |
Fetch a sequence by accession from an authoritative archive (NCBI Nucleotide or Protein, ENA, UniProtKB, the iGEM Registry, Addgene, or the EBI Dbfetch gateway) and hand it downstream as a real record with its annotations. This is how a pipeline starts from a published sequence rather than from whatever happens to be open.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| accession | string | yes | the accession to fetch, e.g. NC_005816, U49845, P38398, BBa_R0040. An NCBI accession may carry a window: NC_005816 REGION: 5000..7000. |
| source | string | no | which archive holds it. Values: ncbi (NCBI Nucleotide), ncbi-protein (NCBI Protein), ena (ENA), uniprot (UniProtKB), igem (iGEM Registry), addgene (Addgene), dbfetch (EBI Dbfetch). |
| db | string | no | Dbfetch only: which of its databases. Only applies when source is dbfetch. |
| format | string | no | Dbfetch only: which of that database's formats. Only applies when source is dbfetch. |
| record_index | number | no | which record to emit when the fetched file holds several (0-based). |
| _subject | object | 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. |
| _files | array | 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. |
Browse the bundled sample library: the real bio files a new project can start from (GenBank and SnapGene plasmids, FASTA sets, alignments, Sanger traces, structures, variant calls and more), each with its id, format and size, and its archive provenance where the corpus records one. This is the headless form of starting a project from a sample: pass an id as a _subject or _files entry's `sample
| Parameter | Type | Required | Notes |
|---|---|---|---|
| query | string | no | words that must all appear in the sample’s id, name, category or format label (case-insensitive), e.g. "pUC", "genbank plasmid", "ab1". Empty lists everything. |
| kind | string | no | restrict to one importer kind (sequence, msa, trace, structure, variants, alignment, tabular, …). Each entry reports its own, so the vocabulary is whatever the library holds. |
| limit | number | no | most entries to return; total says how many matched. |
| _subject | object | 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. |
| _files | array | 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. |
Identify a stretch of DNA by asking the iGEM Registry which published part carries exactly those bases, and hand back that part's own description, Sequence-Ontology role, literature citation and license. The match is decided by comparing bases, never by a name — so a pipeline can label a fragment it has assembled, or check that a feature really is the part it is called.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | yes | the bases to identify — a feature’s span, an assembled fragment, a pasted oligo. |
| name | string | no | a name to narrow the candidates by (a feature name, or a part id like BBa_R0040). It only narrows: the bases decide the match. Leave it empty to compare every candidate of this exact length, which is |
| cap | number | no | most candidate sequences to fetch and compare before stopping and saying so. |
| _subject | object | 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. |
| _files | array | 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. |
Ask one of the ~60 authoritative databases a question and hand its rows downstream — Ensembl, UniProt, ClinVar, gnomAD, ChEMBL, PubChem, InterPro, STRING, PDB, AlphaFold, the GWAS Catalog, PubMed and the rest. Nothing here computes science: a connector returns what the authority already published, which is the rule that an authoritative registry outranks anything kept locally.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| authority | string | yes | which database to ask. Values: pubmed (NCBI PubMed (E-utilities) — literature), pmc-idconv (NCBI PMC ID Converter — literature), europepmc (Europe PMC — literature), openalex (OpenAlex — literature), |
| query | string | yes | what to ask, in the authority's own terms — an identifier, a gene symbol, or one of its command forms such as ensembl_lookup:BRCA2. |
| limit | number | no | cap on rows returned, where the authority honours one. |
| _subject | object | 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. |
| _files | array | 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. |
Fetch a paper's whole open-access text from Europe PMC by PMCID or PMID: title, authors, journal, license, abstract, every section and every figure caption, as Markdown. This is how a pipeline reads a paper rather than its abstract; pass the Markdown to find_accessions for the records it names. Only Europe PMC's open-access subset is served, and an article outside it is refused with Europe PMC's o
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | string | yes | the PMCID (PMC13627669) or PMID (39012345) of the paper. |
| _subject | object | 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. |
| _files | array | 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. |
Find the sequence accessions a text names (a paper's methods, a notebook, a report) and resolve each against its archive: identifiers.org's own pattern for every namespace a fetch target serves, scanned over the text, then one batched search per archive. A span is listed only when the archive returns a record with that accession, so a catalog number with an accession's shape is reported as unresol
| Parameter | Type | Required | Notes |
|---|---|---|---|
| text | string | yes | the text to scan, e.g. the markdown fetch_article returns. |
| _subject | object | 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. |
| _files | array | 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. |
Read one region of ClinVar's monthly release VCF, as the VCF ClinVar publishes: its header, then every record overlapping the region, through the release's tabix index so only those blocks are fetched. The ID column is the ClinVar Variation ID and INFO carries ClinVar's own CLNSIG, CLNREVSTAT and CLNDN. Use it to put ClinVar's calls for a locus beside your own.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| assembly | string | no | which release VCF to read. |
| chrom | string | yes | the chromosome, with or without its chr prefix. |
| start | number | yes | first base of the region (1-based). |
| end | number | yes | last base of the region (1-based, inclusive). |
| max_records | number | no | cap on records returned; the result says when the region held more. |
| _subject | object | 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. |
| _files | array | 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. |
Compare a SET of sequencing reads against one reference in ONE shared frame: align every read to the reference, vote a consensus column by column, and report the positions where the reads differ from it, each with the change it makes to the protein. This is the whole-plate answer that grading reads one at a time cannot give — a variant is accepted only when every covering read agrees, so a single
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reads | array | no | the reads to compare — wire a batch of trace RECORDS in (their names come with them, and the per-read table is keyed by name), wire plain sequences, or name project documents. |
| quality_filter | boolean | no | mask low-quality bases before the vote. Off by default, deliberately: a comparison shows what the FILES say before it shows what a filter says. |
| min_phred | number | no | mask any single base below this phred score. Only applies when quality_filter is true. |
| end_phred | number | no | end trimming: the read becomes readable where three consecutive bases reach this score, and everything outside is masked. A Sanger read is unreliable at both ends by construction, which is why the end |
| genetic_code | number | no | NCBI genetic-code table id, used to say what a variant does to the protein of a CDS on the reference. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Read an alignment window and say how well its reads agree with the reference underneath them, the way the pileup's own bar does: the compared and differing base counts, plus the RefSeq gene models and known dbSNP variants over the same window. The reference is a FASTA in this project or a public UCSC assembly, exactly as the panel offers it. There is no threshold and no verdict: a rate in the tens
| Parameter | Type | Required | Notes |
|---|---|---|---|
| alignment | string | no | which BAM or SAM in this project, by name. Unset, it is the project's only alignment — and it refuses rather than guessing when there is more than one. |
| reference | string | no | what to compare against: a FASTA in this project by name, or a UCSC assembly id (hg38, hg19, mm39 — the same list the panel's picker fetches). Unset is the panel's own default, No reference, and |
| locus | string | no | the window, as a locus string (chrM:3,300-3,460). Unset, it is the whole of the alignment's first reference — the window the panel opens on. |
| gene_track | string | no | which NCBI RefSeq set the gene models come from. Only meaningful against a UCSC assembly. The default is one curated transcript per protein-coding gene, which carries no mitochondrial genes at all — R |
| variants | boolean | no | also report the known dbSNP variants in the window. Off by default, as in the panel: it is a third layer over the reads and a dense window can hold thousands. |
| _subject | object | 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. |
| _files | array | 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. |
Read one window of a BAM or SAM in this project: its reads, the depth across it, and what the pairs say about the library — the same window, filters and record cap the pileup draws. Wire reads into an alignment or a screen the way the pane's own hand-offs do.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| alignment | string | no | which BAM or SAM in this project, by name. Unset, it is the project's only alignment — and it refuses rather than guessing when there is more than one. |
| locus | string | no | the window, as a locus string (ctgA:1-50,001). Unset, it is the whole of the alignment's first reference — the window the panel opens on. |
| min_mapq | number | no | hide reads below this mapping quality, as the pane’s Filter reads operation does. The reads are still counted — hidden says how many this removed. |
| hide_secondary | boolean | no | drop secondary alignments (FLAG 0x100). |
| hide_supplementary | boolean | no | drop supplementary alignments (FLAG 0x800). |
| hide_duplicates | boolean | no | drop reads marked as PCR or optical duplicates (FLAG 0x400). |
| max_reads | number | no | the record cap. More reads than this overlap the window and the result is an even SAMPLE of them, with sampled saying so — the pane’s own cap is the default. |
| _subject | object | 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. |
| _files | array | 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. |
Describe the project the way the copilot is told about it: every file, what it carries and which tool reads it, which files are indexed or paired with each other, and the codon-usage tables a tool resolves by name. Over the API or MCP it describes the files sent as _files; in the app it describes the open project.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| title | string | no | the project's name, for the header line when the files were sent with the call. In the app the open project's own title is used. |
| _subject | object | 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. |
| _files | array | 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. |
List the Sanger trace files in this project (.ab1 / .abi / .scf / .ztr) — the list a batch runs over. Wire its names into a trace reader's For-each so every read in the project is processed in one pipeline, instead of one node per read.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| _subject | object | 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. |
| _files | array | 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. |
What a construct was BUILT from: the recorded operations, the molecules they consumed, how many rounds deep the build goes, and which of the 5 sources the record came from. This is the build history, not the edit history — for what CHANGED in a document and when, call get_document_history instead.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | File id or name. The focused document when omitted, exactly as the panel. |
| limit | number | no | How many steps to return, oldest first. All of them when omitted. |
| molecule | string | no | Keep only the steps that produced or consumed this molecule, by its recorded name — the panel’s graph-node filter. Names that are not in the history are refused with the list of the ones that are. |
| query | string | no | Free text over the operation, the recorded command, its info field, the process id and name, and every molecule the step names — the panel’s step filter. Composes with molecule rather than replacing |
| _subject | object | 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. |
| _files | array | 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. |
Align two constructs' build procedures step by step, in order — was this built the same way as that? Works across formats: a build received as a SnapGene binary and the same build received as an OpenCloning strategy align, because each step's identity is derived from the reaction and its parameters rather than assigned.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | File id or name for THIS side. The focused document when omitted. |
| against | string | yes | File id or name of the construct to compare against, in the same project. |
| key | string | no | what to align on: abstract is the PROCEDURE (the command with its molecules abstracted away, so the same method on different DNA still matches); processId is the EXACT recorded operation, identica |
| _subject | object | 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. |
| _files | array | 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. |
Write a construct's recorded build out as a document: a methods section, a step spreadsheet, the full decoded record, the molecule carrying its own history as GenBank qualifiers, the whole strategy as an OpenCloning document, the runnable QUEEN script that rebuilds it, or the build as an SBOL 2 document. This is the Export tab of the History & Provenance panel (the same seven writers), refusing th
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | File id or name. The focused document when omitted, exactly as the panel. |
| format | string | no | which document to write. methods is the default because it is the panel’s first row and the only one every source can produce; the other six each need something of the record, and asking for one a s |
| sbol_syntax | string | no | which RDF syntax to write the SBOL record in. SBOL is RDF and the six concrete syntaxes encode ONE graph, so this changes how the document is written down and never what it says. rdfxml is the defau |
| _subject | object | 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. |
| _files | array | 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. |
Size the peaks of a fragment-analysis run (.fsa / .hid) against its own size standard, and hand them on as lengths in bases. A fragment run carries no sequence at all — dye channels and a ladder — so this is the node that turns one into numbers a pipeline can act on: allele sizes, a peak table, and the ladder's own measured accuracy beside them.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which fragment file to read: its name (ladder.fsa) or its project file id. A file id is project-specific, so a template ships this unset. |
| method | string | no | the sizing curve. Local methods use the standard fragments nearest each peak and are the more accurate on a real ladder; the global reciprocal fit is less affected by one standard fragment running ano |
| threshold | number | no | minimum peak height, in the channel's own units. |
| min_size | number | no | ignore peaks sized below this. In bases. |
| max_size | number | no | ignore peaks sized above this. In bases. |
| ladder_dye | number | no | which dye carries the size standard. Left unset it is MEASURED, by matching the standard's own scans against each channel's peaks — the copy of the table in the file says nothing about which channel i |
| kit | string | no | name each peak's locus and allele from a marker kit's own ladder definition. Left unset the node reports sizes, which is a complete measurement — a genotype needs a kit. Values: none (No kit — sizes o |
| kit_file | string | no | which kit definition in this project, by file name or file id — for a kit this build does not bundle, which is the ordinary case for a regional or in-house panel. An OSIRIS *_LadderInfo.xml. Left em |
| lane_standard | string | no | the internal lane standard this run used, by its name (ABI-LIZ-600-60-TO-460, Promega-ILS-600, …). Only read when the FILE records no size standard of its own, which is every 3500 .hid: there th |
| ladder_run | string | no | an ALLELIC LADDER of the same kit, in this project, to call against instead of the kit file's nominal sizes: its name (identifiler-ladder.fsa) or its file id. A kit's sizes are the manufacturer's ow |
| require_resolvable | boolean | no | leave a peak unnamed when the neighboring allele is closer than twice THIS RUN's own sizing error at that length, instead of naming the nearest. Off by default: the error is measured with each size-st |
| allele_tolerance | number | no | how far a peak may sit from a ladder allele and still be called it. Above half the repeat unit (4 bases for most STR loci) a peak reaches two alleles and is reported as ambiguous rather than guessed. |
| min_peak_spacing | number | no | two maxima closer than this in one channel are one peak with a noisy top rather than two fragments: the separation is by length and no two fragments differ by less than one base. The taller is kept. 0 |
| adenylation_threshold | number | no | a peak within one base of a taller one in the same locus, below this fraction of its height, is an incompletely adenylated shoulder of it rather than an allele. 0.3333 is NCBI OSIRIS's own Adenylation |
| stutter_threshold | number | no | the same test one repeat below rather than one base. 0.15 is OSIRIS's own StutterThreshold default, and the repeat unit is read off each locus's own ladder rather than typed in. 0 disables it. Only ap |
| pullup_threshold | number | no | a peak whose top sits inside the saturated top of a taller peak in ANOTHER dye, at or below this fraction of it, is named pull-up rather than called. Omitted, the kit's own published sample value from |
| include_ladder_channel | boolean | no | also report the size standard's own peaks. They are the ruler, so they are excluded by default. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Read a Sanger trace (.ab1 / .scf / .ztr) from this project and hand its BASE CALLS onward as a record, with the per-base quality and the trim bounds beside them. This is what makes a sequencing read a pipeline input: verify it against a reference, align it, gate on its quality. The trace SIGNAL stays here — a record crosses a wire as bases, and a peak cannot be written as one.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which trace file to read: its name (read_F.ab1) or its project file id. A file id is project-specific, so a template ships this unset. |
| reverse_complement | boolean | no | read it on the other strand. A reverse primer's trace is the reverse complement of the strand you are verifying, and a name ending _R is the convention for it. |
| trim | boolean | no | emit the quality-trimmed read rather than the whole call list. The bounds are the sliding-window mean-phred bounds the chromatogram panel trims by, so panel and pipeline cut at the same base. |
| min_quality | number | no | the mean phred a window must reach to be kept when trimming. Only applies when trim is true. |
| _subject | object | 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. |
| _files | array | 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. |
The UNPROCESSED signal of a Sanger trace: how many scans the instrument recorded, where each channel's baseline sits, the peak raw value, and how many scans analysis discarded off the front as dye front. This separates an instrument problem from an analysis problem — a read whose analyzed trace looks wrong while its raw channels are clean was mis-analyzed, not mis-run, and a baseline spread far ab
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which trace file to read: its name (read_F.ab1) or its project file id. A file id is project-specific, so a template ships this unset. |
| _subject | object | 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. |
| _files | array | 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. |
Draw a window of a Sanger read as an SVG figure: the four dye traces over their called bases, the per-base Phred bars and a base ruler. The same geometry the Chromatogram tab draws with, so the figure and the tab put every peak in the same place. Name the window around whatever you are asking about — a mutation site, a trim bound, an ambiguous call — because a whole 1,000-base read drawn at once s
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which trace file to draw: its name (read_F.ab1) or its project file id. A file id is project-specific, so a template ships this unset. |
| from | number | no | first base drawn, 1-based and inclusive. Clamped into the read. |
| bases | number | no | how many bases to draw. Keep it to a window you can read: past about 120 the peaks are narrower than the letters over them. |
| width | number | no | figure width. It SETS the per-base zoom for the window asked for, never crops it. In px. |
| trace_height | number | no | height of the peak band, under the ruler, quality and base rows. In px. Advanced. |
| palette | string | no | which ink each dye is drawn in. print is the default here because the figure travels outside the app and onto white; cvd is the color-vision-deficiency-safe set. Values: classic (Classic (ABI)), c |
| quality | boolean | no | print the per-base Phred bars. A file with no confidence (many SCFs) draws none whatever this says. |
| bases_row | boolean | no | print the called bases between the ruler and the peaks. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Trim a Sanger read's low-quality ends, by either of the two methods that answer different questions: the instrument's own Mott record as written into the file, or a sliding mean-Phred window computed here. Returns the kept interval as 1-based inclusive bounds, and the mean quality of what it KEPT beside the mean of what it DISCARDED — the pair that says whether the trim was worth making, because a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which trace file to read: its name (read_F.ab1) or its project file id. A file id is project-specific, so a template ships this unset. |
| method | string | no | auto = the file's own Mott record when it has one and the sliding window when it does not; mott = the instrument's record, which SCF and ZTR never carry; window = always compute it here. |
| win_size | number | no | bases in the sliding window, when the window method runs. |
| min_q | number | no | the mean Phred the window has to hold for a bound to stop walking inward. |
| _subject | object | 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. |
| _files | array | 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. |
Merge one or two Sanger reads into a consensus with the ported SeqTrace caller. With two reads (typically a forward and a reverse of the same amplicon) an IUPAC ambiguity code marks a position the two DISAGREE about; with one read there is nothing to disagree with and a code marks a position where no single base cleared the confidence bar. Returns the consensus, how many positions are ambiguous, a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | the first read: its name or its project file id. |
| second_document | string | no | the second read, usually the reverse of the same amplicon. Leave empty for a single-read consensus, which is a different question and is reported as one. |
| reverse_complement_second | boolean | no | reverse-complement the second read before merging. A reverse read of the same amplicon needs this; two forward reads do not. |
| algorithm | string | no | Bayesian converts each base's Phred to a posterior and combines the reads position by position; legacy lets the higher-confidence base win each position outright. They are different callers, not setti |
| min_conf | number | no | the confidence a base must clear to be called rather than written as a code. SeqTrace range 1-61. |
| quality_trim | boolean | no | trim the consensus's own ends by quality. Note this is the stage primer trimming lives inside, so primer trimming does nothing without it. |
| trim_window | number | no | how many consensus bases the quality-trim mean is taken over. Wider is more forgiving of a single bad base and slower to stop at a genuinely bad end. Advanced. |
| trim_min_good | number | no | how many of those bases must clear min_conf for the window to be kept. It cannot exceed trim_window and is clamped to it rather than refused. Advanced. |
| trim_end_gaps | boolean | no | also cut the gap runs at each end, where only one read reached. With two reads those stretches are single-read consensus and read as agreement when they are not. Advanced. |
| trim_primers | boolean | no | cut the primers off the consensus ends. It runs INSIDE the quality-trim stage, so turning it on turns that stage on too. |
| forward_primer | string | no | the forward primer to cut, 5→3. Only applies when trim_primers is true. |
| reverse_primer | string | no | the reverse primer to cut, 5→3. Only applies when trim_primers is true. |
| primer_match | number | no | the fraction of a primer that must match for it to be cut. 1 is exact; lower tolerates the mismatches a real read carries at its noisy start. Only applies when trim_primers is true. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Compare a sequencing RESULT against the construct you designed and say what differs, where, and what it lands in. Aligns the two, reports every substitution, indel and uncalled position, then maps each onto the design's features and ranks them by Ensembl's published consequence severity — so a pipeline can gate on 'nothing worse than synonymous' rather than on a bare difference count.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| design | string | yes | the construct you INTENDED — wire an upstream record or name a library document. Its features come with it, and they are what turns a difference into a consequence. |
| result | string | yes | what actually came back from sequencing — wire a record or name a document. |
| word_size | number | no | alignment limit wordSize, as the Verify panel's own slider sets it. Advanced. |
| band_margin | number | no | alignment limit bandMargin, as the Verify panel's own slider sets it. Advanced. |
| min_result_fraction | number | no | alignment limit minResultFraction, as the Verify panel's own slider sets it. Advanced. |
| min_coverage | number | no | alignment limit minCoverage, as the Verify panel's own slider sets it. Advanced. |
| confident_coverage | number | no | alignment limit confidentCoverage, as the Verify panel's own slider sets it. Advanced. |
| match | number | no | alignment limit match, as the Verify panel's own slider sets it. Advanced. |
| mismatch | number | no | alignment limit mismatch, as the Verify panel's own slider sets it. Advanced. |
| gap_open | number | no | alignment limit gapOpen, as the Verify panel's own slider sets it. Advanced. |
| gap_extend | number | no | alignment limit gapExtend, as the Verify panel's own slider sets it. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Quantify a CRISPR edit from a pair of Sanger traces — how much of the population was edited, what the indel spectrum looks like, and how well the model fits. Synthego ICE: the CONTROL trace gives the unedited sequence, the EDITED trace is decomposed into a mixture of proposed indels around each guide's cut, and the abundances are fitted. Answers the question a screen cannot: not whether a guide is
| Parameter | Type | Required | Notes |
|---|---|---|---|
| control | string | yes | the UNEDITED trace, by file name or id — it supplies the reference the edited read is decomposed against. |
| edited | string | yes | the EDITED trace, by file name or id. |
| guides | array | yes | the guide spacers, RNA accepted. Each is located in the CONTROL on either strand, so the cut sites come from the data rather than from a coordinate you supply. |
| donor | string | no | optional HDR donor / ssODN. Given one, ICE also proposes the recombination outcome and reports an HDR percentage; left empty there is no HDR arm rather than a zero. |
| indel_max_size | number | no | largest single-cut indel modeled either side of the cut — ICE's own CLI default is 20. In bp. Advanced. |
| base_editing | boolean | no | also fit every single-base change on the PAM-distal side of each cut, for a base editor. Left false, the scores stay comparable with published ICE numbers, which the extra proposals would move. Advanc |
| _subject | object | 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. |
| _files | array | 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. |
Quantify a CRISPR edit from a pair of Sanger traces by TIDE (Brinkman et al.) — the abundance of each indel SIZE in the sequenced population, with a p-value per size class, the total editing efficiency, the goodness of fit, and the base composition of the +1 insertion. This is a different question from crispr_quantify_edits, not a cheaper version of it: ICE fits a mixture of whole proposed alleles
| Parameter | Type | Required | Notes |
|---|---|---|---|
| control | string | yes | the UNEDITED trace, by file name or id — every indel class is the control trace shifted, so this read IS the model. |
| edited | string | yes | the EDITED trace, by file name or id. |
| guide | string | yes | the guide spacer, RNA accepted. TIDE decomposes around ONE break, so this is a single guide rather than a list — it is located in the control on either strand and the break is placed three bases 5-pri |
| seq_start | number | no | first base of the READ to use. The start of a Sanger read is poor quality; upstream's own web app starts at 100. In bp. |
| seq_end | number | no | last base of the READ to use, clamped down to the shorter of the two reads if it overruns. In bp. |
| max_shift | number | no | largest indel size modeled, in both directions. One basis function is fitted per size from -max_shift to +max_shift, so this bounds what can be reported at all. In bp. |
| p_threshold | number | no | an indel class is called PRESENT below this p-value. A 0% class and a non-significant class are different answers, which is why this is a knob rather than a constant. Advanced. |
| window_start | number | no | first base of the decomposed region. 0 asks the engine to place the window after the break itself, which is what upstream does when given no boundaries. In bp. Advanced. |
| window_end | number | no | last base of the decomposed region. 0 = as far as the shorter read allows. In bp. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Quantify BASE EDITING from a single Sanger trace, with no control read — the EditR method (Kluesner et al. 2018), ported and graded against the authors' own R. A base editor makes no double-strand break and no indel, so it is invisible to ICE and TIDE: the edit is a C→T or A→G inside the protospacer that shows up only as a second peak under the called base. This models the trace's OWN background f
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which trace file to read: its name (read_F.ab1) or its project file id. LEAVE IT EMPTY to run on the chromatogram tab that is open. A file id is project-specific, so a template ships this unset. |
| guide | string | yes | the protospacer, 5'→3', without the PAM. Matched exactly against the read's own base calls; the coordinates it lands on come back in the result. |
| guide_is_reverse_complement | boolean | no | search for the guide's reverse complement. A C→T edit on the guide strand then reads as G→A in the result. |
| p_value_cutoff | number | no | a base is called as edited when its share of the position's signal clears this trace's own noise model at this probability. EditR's own default is 0.01. |
| trim5 | number | no | first base of the read the background model may be fitted on, 1-based inclusive. GIVE BOTH BOUNDS OR NEITHER — upstream errors on a lone one rather than filling the other in. Left unset, upstream's au |
| trim3 | number | no | last base of the read the background model may be fitted on, 1-based inclusive. Pair it with trim5. |
| guide_start | number | no | place the guide yourself, 1-based inclusive in the read's own base calls, instead of matching it exactly. GIVE BOTH BOUNDS OR NEITHER. This is what a read carrying a sequencing error inside the protos |
| guide_end | number | no | the other end of an explicit placement, 1-based inclusive. Pair it with guide_start. |
| _subject | object | 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. |
| _files | array | 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. |
Ask whether a Sanger trace splits into TWO READS OF DIFFERENT LENGTH, which is what a heterozygous insertion or deletion does: clean up to the indel, then a superposition of two sequences offset by its length. This is not mixed-base calling — that asks whether two BASES sit at one position and is blind to a length difference. Emits where the split starts, how long it is, and the two allele sequenc
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which trace file to read: its name (read_F.ab1) or its project file id. LEAVE IT EMPTY to run on the chromatogram tab that is open, in which case the answer also appears in the rail. A file id is pr |
| table | string | no | the instrument and polymer the quality scale was calibrated on. There is no universal default: a base scores differently under a different table, and the detector gates on a quality JUMP. |
| quality_value_reading | string | no | corrected = read the quality values as TraceTuner's own header declares them, which is the only reading that can detect anything; upstream = reproduce the program as shipped, whose detector never fire |
| breakpoint_scan | number | no | skip the search and measure the indel at this scan position on the x axis. -1 searches for it. |
| _subject | object | 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. |
| _files | array | 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. |
Re-score a Sanger trace's own base calls from the signal, replacing the instrument's Phred values with ones measured from the peaks. Keeps the bases; only their quality changes. Reports the read's mean quality, its lowest-scoring base and the four trace parameters that base was scored from, which are the whole input to the quality table.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which trace to run on: a file name (read_F.ab1) or its project file id. Leave unset to use the trace tab on screen. A file id is project-specific, so a template ships this unset. |
| table | string | no | the instrument/polymer calibration table to score against. The same signal scores differently under each, so a quality value is only interpretable with the table named. Defaults to ABI 3730 POP-7. |
| _subject | object | 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. |
| _files | array | 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. |
Call the bases of a Sanger trace from the signal, discarding the instrument's calls and deriving the bases, their positions and their quality from the peaks. The read can come back a DIFFERENT LENGTH than the file's. This ANSWERS the question; adopt_trace_calls is what puts the answer onto the read.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which trace to run on: a file name (read_F.ab1) or its project file id. Leave unset to use the trace tab on screen. A file id is project-specific, so a template ships this unset. |
| table | string | no | the instrument/polymer calibration table to score against. The same signal scores differently under each, so a quality value is only interpretable with the table named. Defaults to ABI 3730 POP-7. |
| _subject | object | 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. |
| _files | array | 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. |
Call the bases of a Sanger trace AND ask at every position whether a second allele is present, writing a two-base IUB code (R, Y, S, W, K, M) where it is. mode: het assumes the two alleles are present in equal amounts, which is the diploid heterozygote case; mode: mix assumes nothing about their ratio, for a mixed template, a contaminated read or a pooled sample. The two disagree: on this repo
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which trace to run on: a file name (read_F.ab1) or its project file id. Leave unset to use the trace tab on screen. A file id is project-specific, so a template ships this unset. |
| table | string | no | the instrument/polymer calibration table to score against. The same signal scores differently under each, so a quality value is only interpretable with the table named. Defaults to ABI 3730 POP-7. |
| mode | string | no | het = the two alleles are assumed present 1:1 (a diploid heterozygote); mix = no assumption is made about their ratio. |
| min_ratio | number | no | how tall a second peak must be, as a fraction of the called peak, before the search will consider it as a second allele. Lowering it widens what is considered, which is not the same as calling more mi |
| _subject | object | 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. |
| _files | array | 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. |
Replace a Sanger read's own base calls with TraceTuner's, on the trace that is open, so the rest of the editor works from the re-called read: its sequence, its consensus, its verification against a reference, and every export. The signal is untouched — this is the same electropherogram with a second opinion about where the bases are — and every coordinate already on the read is carried across the
| Parameter | Type | Required | Notes |
|---|---|---|---|
| mode | string | no | which reading to adopt. rescore keeps the instrument's bases and only re-measures their confidence; denovo derives the bases from the signal and can return a different read LENGTH; het and mix |
| table | string | no | the instrument and polymer the quality scale was calibrated on. There is no universal default: a base scores differently under a different table. |
| min_ratio | number | no | for het and mix only: how tall a second peak must be, as a fraction of the called one, to be called as a second allele. Ignored by the other two modes. Only applies when mode is het or mix. |
| _subject | object | 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. |
| _files | array | 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. |
Put an open Sanger read back on the base calls its FILE carries, undoing an adopted re-call. The same carry runs in the other direction, so the trim window, the hand-corrected calls and the annotations come back with it rather than being left on indices the file does not have. Not the same as clearing the read's edits, which also discards the trim and the manual calls.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| _subject | object | 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. |
| _files | array | 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. |
Write a Sanger read out in any of the eight formats the trace editor's Export section offers, and hand the file back as TEXT in the pipeline rather than as a download. Reports what the chosen target DROPPED — a read written as FASTA loses its annotations, and every target but FASTQ loses the per-base quality — because those losses are invisible in the file itself. Trims the ends first when asked,
| Parameter | Type | Required | Notes |
|---|---|---|---|
| document | string | no | which trace file to write: its name (read_F.ab1) or its project file id. A file id is project-specific, so a template ships this unset. |
| format | string | no | the target. FASTQ is the only one that carries the per-base Phred; GenBank and EMBL are the only two that carry annotations; the rest are a bare sequence. |
| trim | string | no | trim the ends before writing, the same three ways the Trim section does. none writes the file's calls as they are; auto uses the file's own Mott record when it has one and the sliding window when |
| use_internal_name | boolean | no | name the record and the filename from the instrument's own sample record (ABIF SMPL) rather than from the file name. The instrument's name is often a plate well that means nothing outside the run; a |
| _subject | object | 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. |
| _files | array | 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. |
De-novo protein domain and family annotation: submits a protein to EMBL-EBI InterProScan and returns every member-database signature that matches it — Pfam, CATH-Gene3D, SUPERFAMILY, PANTHER, PROSITE, SMART, CDD and the rest — with its InterPro entry, its GO terms, its coordinates and its E-value. This is the DOMAIN half of the Protein domains panel; for the short linear motifs a profile scan cann
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence, one-letter codes; wire it from translate_sequence or read it off a CDS. |
| applications | string | no | member databases to run, comma-separated, using InterProScan's own ids (Pfam, Gene3D, SUPERFAMILY, PANTHER, PROSITE …). Empty runs the service's own default set, which is every database it has enabled |
| goTerms | boolean | no | ask InterPro to attach Gene Ontology terms to the integrated entries, so a match carries its function rather than only its accession. |
| pathways | boolean | no | ask InterPro to attach pathway cross-references (Reactome, KEGG, MetaCyc) to the integrated entries. |
| representativeOnly | boolean | no | keep only the matches InterProScan itself marks representative — its own answer to “which of these overlapping signatures describes this region best”. |
| integratedOnly | boolean | no | keep only signatures integrated into an InterPro entry, dropping member-database hits InterPro has not curated into one. |
| maxEvalue | number | no | drop matches whose E-value is worse than this. 0 applies no threshold. A match the member database scores no E-value for (Coils, MobiDB-lite, Phobius) is KEPT either way — it has not failed the thresh |
| string | no | EBI requires a contact address on every submission (their abuse contact, not a login). Left empty, the one saved in any EMBL-EBI panel is used, which only the in-browser doors can read. It is sent to | |
| visibleLibraries | string | no | keep only matches from these member databases, comma-separated, as the RESULT document spells them (PFAM, GENE3D, SUPERFAMILY, CDD, PANTHER, MOBIDB_LITE …). This narrows what comes back; `applications |
| sortBy | string | no | row order of the returned matches. Values: length (longest first), position (position along the protein), evalue (best E-value first), library (by member database). |
| _subject | object | 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. |
| _files | array | 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. |
RPS-BLAST a protein against NCBI's Conserved Domain Database (CDD) or one of its member collections (Pfam, SMART, COG, KOG, PRK, TIGR, NCBI-curated), through NCBI Batch CD-Search. Returns every domain hit with its hit type (specific, non-specific, superfamily, multi-domain), residue span, E-value, bit score, CDD accession, superfamily cluster and whether the alignment stops short of either end of
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | no | the protein sequence, one-letter codes; wire it from translate_sequence or read it off a CDS. |
| dna | string | no | instead of protein: DNA whose six reading frames are sent as six proteins, labeled frame +1 … frame -3; each hit names its frame in queryLabel. |
| smode | string | no | NCBI's search mode: automatic uses precomputed results where they exist, precomputed never runs a search, live always runs one. Only live honours db, evalue and maxhit. Values: auto (automatic), prec |
| db | string | no | the PSSM collection, as the live Batch CD-Search form names it (cdd, cdd_ncbi, oasis_pfam, oasis_smart …); live mode only. Only applies when smode is live. |
| evalue | number | no | E-value cutoff; live mode only (automatic and precomputed apply 0.01). Only applies when smode is live. |
| maxhit | number | no | most hits per protein; live mode only (automatic and precomputed apply 500). Only applies when smode is live. |
| compbasedadj | number | no | 0 no composition-based statistics · 1 composition-based statistics · 2 composition matrix adjust · 3 forced full matrix adjust. |
| filter | boolean | no | mask low-complexity regions of the query before searching. |
| dmode | string | no | which hits come back: concise (the best hit per region), standard (the best per source database per region) or full (every hit). Values: rep (concise), std (standard), full (full). |
| _subject | object | 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. |
| _files | array | 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. |
rpsblast, run on this machine: find conserved domains in a protein against NCBI's SMART domain models (1,011 PSSMs from CDD). NCBI BLAST+ 2.17.0's algorithms, checked against the rpsblast program on every bundled protein. Nothing is sent anywhere; for all of CDD use rps_blast_cdd, which goes to NCBI.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein, one-letter codes; wire it from translate_sequence or read it off a CDS. |
| evalue | number | no | report alignments with E at most this (-evalue); BLAST's default is 10. |
| max_target_seqs | number | no | most domain models reported (-max_target_seqs). |
| source | string | no | where the SMART database is read from: 'bundled' (a byte-identical copy of NCBI's file) or 'ncbi' (NCBI's FTP site, now). Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
rpstblastn, run on this machine: find conserved domains in DNA by searching all six reading frames against NCBI's SMART domain models (1,011 PSSMs from CDD). Leave sequence empty to search the open record. NCBI BLAST+ 2.17.0's algorithms, checked against the rpstblastn program on every bundled GenBank record. Nothing is sent anywhere; for all of CDD use rps_blast_cdd on a translated protein.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | no | the DNA to search, 5′→3′; leave empty to search the open record. Both strands are searched. |
| evalue | number | no | report alignments with E at most this (-evalue); BLAST's default is 10. |
| max_target_seqs | number | no | most domain models reported (-max_target_seqs). |
| comp_based_stats | number | no | composition-based statistics: 1 on (the default, Schäffer et al. 2001), 0 off. |
| genetic_code | number | no | NCBI genetic code used to translate the six frames (-query_gencode). |
| source | string | no | where the SMART database is read from: 'bundled' (a byte-identical copy of NCBI's file) or 'ncbi' (NCBI's FTP site, now). Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
DELTA-BLAST, run on this machine: build a position-specific profile for a protein from the SMART conserved domains it contains, then search other proteins with it (one PSI-BLAST iteration) — more sensitive than BLASTP for distant homologs. Searches the open record's coding sequences unless subjects gives FASTA. NCBI BLAST+ 2.17.0's algorithms, checked against the deltablast program on every bund
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein, one-letter codes; wire it from translate_sequence or read it off a CDS. |
| subjects | string | no | the proteins to search, as FASTA; leave empty to search the open record's coding sequences. |
| domain_inclusion_evalue | number | no | conserved-domain hits with E below this build the profile (-domain_inclusion_ethresh). |
| threshold | number | no | lowest profile word score seeded in the lookup table (-threshold). Advanced. |
| evalue | number | no | report alignments with E at most this (-evalue); BLAST's default is 10. |
| max_target_seqs | number | no | most proteins reported (-max_target_seqs). |
| source | string | no | where the SMART database is read from: 'bundled' (a byte-identical copy of NCBI's file) or 'ncbi' (NCBI's FTP site, now). Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Short linear motifs in a protein: degrons, docking sites, targeting signals, cleavage and modification sites — the three-to-eleven-residue functional sites a profile-HMM domain scan cannot see. Runs ELM's own class patterns ON THIS MACHINE; only the class table is fetched. Applies ELM's context filters: the chance-probability cutoff, family selection, and the globular-domain filter when you pass d
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein sequence, one-letter codes; wire it from translate_sequence or read it off a CDS. |
| expectCutoff | number | no | ELM's class gate: classes whose chance probability per residue exceeds this are not scanned at all. ELM's own default is 0.01; 0 scans every class, which is the resource's “all found (before filtering |
| families | string | no | restrict to these ELM families, comma-separated, from CLV, DEG, DOC, LIG, MOD, TRG. Empty is no restriction and scans every family; the literal "none" is a restriction to no family and scans nothing, |
| filterInDomains | boolean | no | apply ELM's globular-domain filter, dropping motifs buried inside a folded domain. Takes the domains from domains when you pass them, and otherwise from the scan the Protein domains panel currently |
| domains | string | no | the globular domains to bury motifs in, as start-end residue ranges (1-based, inclusive), comma-separated, each optionally labeled start-end@label so a dropped hit can say what buried it — e.g. `2 |
| compartments | string | no | restrict to motifs whose class is annotated for these cell compartments, as GO ids, comma-separated (e.g. GO:0005634 for nucleus). Empty runs no compartment filter, which is ELM's own default. |
| species | string | no | the species the protein comes from, as an NCBI Taxonomy id (e.g. 4932) or a scientific name (e.g. Saccharomyces cerevisiae), for ELM's taxonomic range filter: a motif whose class ELM does not place in |
| structuralContext | string | no | score each motif's structural context, as ELM's structure filter does. Empty applies nothing, which is the panel's own default. alphafold uses the predicted model and yields Q_acc only. A four-chara |
| _subject | object | 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. |
| _files | array | 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. |
The individual catalytic, substrate-binding, metal-binding and interface residues a member database annotates INSIDE a domain, for a known protein. Takes a UniProt accession. This is what InterProScan itself does not return — its per-location site array comes back empty — so it is a separate lookup against InterPro, keyed to an entry whose sequence the residue numbers belong to.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| accession | string | yes | UniProt accession, e.g. P00330. It must be the entry whose CURRENT sequence you mean: residues are numbered against it, so an accession for a protein that merely resembles yours puts a catalytic resid |
| _subject | object | 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. |
| _files | array | 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. |
Run a multi-lane virtual agarose gel and return its READING, not just its bands: how many lanes carrying how many bands over what range, positioned by which ladder, plus only the cautions this plate earned — a lane running off the top or bottom of the reference ladder entirely (no mark to interpolate against, so the position is the calibration curve extrapolated), a band inside the ladder but outs
| Parameter | Type | Required | Notes |
|---|---|---|---|
| lanes | array | yes | the lanes, in edge order — each a [bp, form] band list, which is exactly what run_gel_lane emits. A bare list of fragment lengths is also accepted and runs at the plate form. Several wires land |
| lane_names | array | no | a name per lane, in the same order. Unnamed lanes become Lane 1, Lane 2, … — the reading names the lane every caution is about, so a plate of unnamed lanes still says which one is off scale. |
| ladder | string | no | the reference ladder drawn beside the samples, and what "off the scale" is measured against. Values: generuler_1kb_plus (GeneRuler 1 kb Plus (75–20,000)), hi_lo (Hi-Lo DNA Marker (50–10,000)), generul |
| agarose_percent | number | no | the casting percentage, which activates a concentration law and a resolving window. LEAVE UNSET for the bench's own default: ladder-calibrated migration, interpolated on the ladder's measured curve wi |
| mobility_model | string | no | which empirical agarose-% mobility law — helling-goodman-boyer (Helling–Goodman–Boyer (default)) · rill-van-winkle (Rill/Van Winkle). Values: helling-goodman-boyer (Helling–Goodman–Boyer (default)), r |
| form | string | no | the DNA topology a lane runs at when its bands do not carry one. Only moves a band under a concentration law: ladder-calibrated migration reads every band off the ladder's own curve, and the reading s |
| render_mode | string | no | how the plate would be drawn. Echoed into the derivation chain because a raster merges what bands separate, so the reading is about a different picture. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Build DnaCauldron's assembly report from an assembly result: the per-construct summary table, the constructs and errors spreadsheets as pandas-compatible CSV, and the Outcome / Number of assemblies stats. Wire golden_gate_assemble or gibson_assemble's products, errors and warnings outputs into it.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| products | array | no | the enumerated constructs — wire an assembly node's products output. Each needs id, sequence and fragmentNames, which is what both assembly nodes emit. |
| errors | array | no | structured assembly errors — wire the assembly node's errors output. These become the errors spreadsheet, which is the most useful thing in a report about a run that did not work. |
| warnings | array | no | structured assembly warnings — wire the assembly node's warnings output. |
| assembly_name | string | no | the name for this assembly: the assembly_name column of the summary table and the first field of every errors row. |
| enzyme | string | no | the Type-IIS enzyme, for a method that has one — it becomes the report's enzymes column, mirroring DnaCauldron's Type2sRestrictionAssembly.get_extra_construct_data(). Leave it empty for Gibson, wh |
| _subject | object | 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. |
| _files | array | 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. |
Gene sets for an organism, fetched from the authority at run time instead of a bundled list: Gene Ontology terms from the GO Consortium's own annotation file for the organism (each term's direct annotations, NOT annotations dropped, term names from QuickGO), or Reactome pathways from Reactome's AnalysisService (each pathway's members among the genes you submit, in the species Reactome resolves). R
| Parameter | Type | Required | Notes |
|---|---|---|---|
| authority | string | no | go: every GO term with a direct annotation in the organism. reactome: Reactome's pathways, restricted to the genes in genes. Values: go (GO · GO Consortium), reactome (Reactome · AnalysisService). |
| organism | string | yes | the organism: an NCBI taxon ID (7227) or a name (Drosophila melanogaster, human); GO resolves it through NCBI Taxonomy, Reactome resolves it itself. |
| genes | string | no | reactome: the genes to map, one per line (a 'gene value' line keeps its first field), e.g. a DE run's tested genes, in an ID system Reactome reads (Ensembl, UniProt, NCBI Gene, a model organism's own) |
| _subject | object | 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. |
| _files | array | 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. |
Score CRISPR guides with DeepHF: a predicted knockout EFFICIENCY between 0 and 1 for wild-type SpCas9 (U6 or T7 promoter), eSpCas9(1.1) or SpCas9-HF1. It is not a z-score and not comparable with Rule Set 3 — the two answer different questions and must never be averaged or ranked together. Takes 23-nt protospacers (20-nt spacer + NGG PAM), which is what crispr_design_guides produces; a guide whos
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protospacers | array | yes | the 23-nt protospacers to score — 20-nt spacer plus the 3-nt PAM, exactly as DeepHF takes them. Anything that is not 23 nt of unambiguous A/C/G/T ending in GG scores null rather than being silently tr |
| model | string | no | which published model to score under. This is a scientific choice about YOUR experiment — which Cas9 variant, and which promoter the sgRNA is expressed from — not a quality setting, and scores from tw |
| _subject | object | 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. |
| _files | array | 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. |
Score CRISPR guides with DeepSpCas9 (Kim et al. 2019, Sci Adv 5:eaax9249): a predicted INDEL FREQUENCY IN PERCENT for wild-type SpCas9. It is a third quantity, not a second opinion: Rule Set 3 is a z-score across a screen and DeepHF is an efficiency in [0, 1], so none of the three may be averaged or ranked together. Takes the 30-nt CONTEXT the model reads whole (4 nt + 20-nt spacer + 3-nt PAM + 3
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contexts | array | yes | the 30-nt contexts to score, exactly as DeepSpCas9 takes them: 4 nt upstream, the 20-nt spacer, the 3-nt PAM and 3 nt downstream. Anything that is not 30 nt of unambiguous A/C/G/T scores null, with th |
| _subject | object | 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. |
| _files | array | 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. |
Score protein substitutions with ESM-2, the zero-shot way facebookresearch/esm's own predict.py does: how much less (or more) likely the mutant residue is than the wild type at that site, under a protein language model. It ranks a saturation library without an assay — and it is a RANKING IN NATS, not a stability measurement: it carries no kcal/mol and is calibrated against nothing. THE MODEL I
| Parameter | Type | Required | Notes |
|---|---|---|---|
| protein | string | yes | the protein the positions are numbered against, one letter per residue. Wire a translation, or the CDS protein the library was designed on — the positions mean nothing without it. |
| variants | array | yes | the substitutions, in A24D form: wild-type residue, position, mutant residue. Every one is checked against protein first, because a scored substitution whose wild type does not match is a confiden |
| model | string | no | which published ESM-2 ONNX export to score under. The three sizes are a download decision as much as an accuracy one, and the label says which. Values: esm2_t6_8M (ESM-2 8M · 30.3 MB), esm2_t12_35M (E |
| strategy | string | no | how the score is computed. masked-marginals is ESM-1v's recommendation — one forward pass per residue, each with that site masked. wt-marginals is one pass over the wild type and the paper reports |
| offset_idx | number | no | the number position counts from. 1 is ordinary protein numbering; set it when your variants are numbered against a mature chain or a construct that starts partway in. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Read an Affymetrix copy-number container (CNCHP/CYCHP/OSCHP/CHP) in this project and say what is in it: the algorithm and array that produced it, its data sets and their graphs, the per-chromosome marker index the file carries, and — for one chromosome — each graph decimated to a summary with its real range. Values the analysis left undefined are counted and reported, never plotted as zero. NO GEN
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which copy-number file in this project, by name. Unset, it is the project's only one — and it refuses rather than guessing when there is more than one. |
| data_set | string | no | which data set to read, by name. Unset is the file's FIRST, which is what the panel opens on. |
| chromosome | number | no | which chromosome's markers to summarize, as THE FILE numbers them. The autosomes are 1-22; which numbers are X and Y is stated by the file's own header (xChromosome/yChromosome, which both bundled |
| bins | number | no | how many buckets to decimate each graph into. The panel uses one per pixel column of its plot; a smaller number here is a coarser summary of the same data. |
| compare | string | no | a SECOND copy-number file in this project, by name, to read over the SAME chromosome, the same window and the same buckets — the overlay the canvas draws, as numbers. Its chromosome is matched by LABE |
| start | number | no | first base of the region to summarize, on the selected chromosome. Unset is the chromosome's first marker. Clamped to what the file's markers actually cover, because a locus is a position in the assem |
| end | number | no | last base of the region to summarize. Unset is the chromosome's last marker. Given with start, the graphs are decimated over that window instead of the whole chromosome: the same thing the panel's R |
| _subject | object | 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. |
| _files | array | 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. |
Segment one chromosome of an Affymetrix copy-number container by up to four independent methods and report where they agree. The HMM lays a copy-number model over the log2 ratios and calls a state per segment; circular binary segmentation finds where the mean changes with no model of what a gain looks like, by permutation test; piecewise constant fitting picks the piecewise-constant curve minimizi
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which copy-number file in this project, by name. Unset, it is the project's only one — and it refuses rather than guessing when there is more than one. |
| data_set | string | no | which data set to segment, by name. Unset is the file's FIRST, which is what the panel opens on. |
| chromosome | number | no | which chromosome to segment, as the file numbers them (1-22, then 23=X, 24=Y, 25=MT — the file's own convention). Unset is the first the index carries, which is what the panel selects. |
| graph | string | no | which graph column to segment. Unset is the first log2-ratio column, which is what the panel segments. A column that is not a log2 ratio is refused rather than segmented: a copy-number STATE column is |
| methods | string | no | which methods to run, comma-separated: hmm, cbs, pcf, pelt. Unset runs all four, because the point of this node is where they agree. The panel has each of them off until asked, so running one |
| hmm_model | string | no | which copy-number state model the HMM calls against. file is the model the container's own header states, and is used when unset if the file states one; otherwise the first preset. apt-cn-state is |
| cbs_seed | number | no | CBS accepts a boundary by permutation test, so the run is seeded and about 1 borderline dataset in 40 segments differently under a different seed. Same default as the panel. |
| cbs_undo_splits | string | no | DNAcopy's undo.splits, the post-hoc merge over what CBS found: none keeps every significant split, sdundo merges adjacent segments whose medians are within cbs_undo_sd trimmed SDs (is this bou |
| cbs_undo_sd | number | no | DNAcopy's undo.SD: the merge threshold in trimmed noise SDs. Read only when cbs_undo_splits is sdundo. Same default as the panel. Only applies when cbs_undo_splits is sdundo. |
| cbs_trim | number | no | DNAcopy's trim: the fraction cut from each tail before sdundo measures the noise SD. Read only when cbs_undo_splits is sdundo. Same default as the panel. Only applies when cbs_undo_splits is sdund |
| cbs_undo_prune | number | no | DNAcopy's undo.prune: the fractional increase in residual cost pruning may accept. Read only when cbs_undo_splits is prune. Same default as the panel. Only applies when cbs_undo_splits is prune. |
| cbs_eta | number | no | DNAcopy's eta: the error budget for stopping each permutation test early once its outcome is settled. Not the significance level; any value but 0.05 recomputes the stopping boundary. Same default as |
| pcf_gamma | number | no | PCF's penalty per jump — how much evidence a level change must carry. Scaled by the squared MAD noise estimate unless pcf_normalize is off, which is what makes 40 mean the same thing on a quiet arra |
| pcf_kmin | number | no | PCF's shortest allowed segment, in markers — the finest change the fit may claim. Same default as the panel. |
| pcf_method | string | no | which piecewise-constant fit: auto (copynumber's own rule — the exact dynamic program under 400 markers, its selectFastPcf approximation above), exact, or fast. Both are ported and graded agains |
| pcf_normalize | boolean | no | scale the PCF penalty by the squared MAD noise estimate (the vendor’s normalize). Off makes gamma an absolute penalty in squared log2 units, which is a different parameter wearing the same name. Sam |
| pelt_penalty | string | no | PELT's penalty, and the reason its knob is a different KIND of knob from PCF's gamma: it is an information criterion, so the number of segments follows from a model-selection rule rather than from a c |
| pelt_penalty_value | number | no | the cost a boundary must save to be worth buying, in the cost function's own units. Read ONLY when pelt_penalty is Manual; the named criteria derive their own from the marker count. Same default as |
| pelt_minseglen | number | no | PELT's shortest allowed segment, in markers (changepoint's minseglen) — the finest change the fit may claim. Same default as the panel. |
| pelt_standardize | boolean | no | divide by the robust MAD before fitting. ON by default, and this is the one PELT default that is ours rather than the vendor's, because the vendor documents the assumption and does not enforce it: a c |
Scan every indexed chromosome of an Affymetrix copy-number container and report what the file itself called: gains, losses and stretches of homozygosity, with their positions, marker counts and spans, plus a per-chromosome summary. Reads the file's own CNState and LOH columns and infers nothing — for a second opinion computed from the log2 ratios, use copy_number_segment. A chromosome that was rea
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which copy-number file in this project, by name. Unset, it is the project's only one — and it refuses rather than guessing when there is more than one. |
| data_set | string | no | which data set to scan, by name. Unset is the file's FIRST, which is what the panel opens on. |
| min_markers | number | no | ignore any run shorter than this many markers. The default counts everything the file called, including single markers, because a reporting floor belongs to the laboratory and not to this tool. |
| min_bases | number | no | ignore any run spanning fewer bases than this. Default 0, for the same reason as min_markers. Note a single-marker run spans 0 bases. |
| _subject | object | 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. |
| _files | array | 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. |
Say what a genomic region holds in the reference tracks: the genes and RefSeq transcripts it overlaps, which complete coding sequences it CONTAINS (the only case where a residue-level design is honest), the DGV structural variants seen there in control populations with their frequencies, and how much of it lies in segmental duplications and how similar the best paralogue is. Every track answers wi
| Parameter | Type | Required | Notes |
|---|---|---|---|
| build | string | yes | the assembly the coordinates are on, by the UCSC name the cached tracks use (hg19, hg38). A build with no cached track is refused by name rather than answered empty. |
| chromosome | string | yes | UCSC-style sequence name; a bare 17 or X is read as chr17/chrX. |
| start | number | yes | first base of the region, 1-based. |
| end | number | yes | last base of the region, 1-based and inclusive. |
| dosage | string | no | which DGV evidence is comparable: loss for a deletion call, gain for a duplication, any for either. Balanced and unclassified variant types (insertions, inversions) are never counted as dosage e |
| tracks | string | no | which tracks to read, comma-separated: genes, dgv, segdups. Unset reads all three. The coding verdict comes with genes. |
| _subject | object | 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. |
| _files | array | 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. |
Read one window of a genome the way a genome browser shows it: the cytogenetic bands it spans, the transcripts in the chosen RefSeq set, which residues of each protein the window encodes (translated from the assembly’s own bases), how many dbSNP 155 variants fall in it and how many ClinVar calls pathogenic, and every CRISPR site for the chosen nuclease (SpCas9 unless told otherwise) with its stran
| Parameter | Type | Required | Notes |
|---|---|---|---|
| assembly | string | yes | the UCSC assembly name (hg38, hg19, mm39…). |
| gene | string | no | a gene symbol; the window is its MANE Select (or HGNC) transcript with a 2% margin either side. Takes precedence over locus. |
| locus | string | no | the window, 1-based and inclusive, when no gene is given. |
| gene_track | string | no | which RefSeq set the transcripts and protein residues come from. Values: ncbiRefSeqSelect (RefSeq Select and MANE), ncbiRefSeqCurated (RefSeq Curated), ncbiRefSeq (RefSeq All), ncbiRefSeqPredicted (Re |
| nuclease | string | no | which nuclease the CRISPR sites are enumerated for (its PAM and cut rule). On-target scores are SpCas9-trained and come back null for any other. Values: SpCas9 (SpCas9 · NGG), SpCas9-NG (SpCas9-NG · N |
| _subject | object | 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. |
| _files | array | 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. |
Place an Affymetrix copy-number sample's own calls in ClinGen's curated regions: for each region, which gains, losses or stretches of homozygosity fall in it, at what reciprocal overlap, and how much of the region they cover between them. Regions come from ClinGen's dosage-sensitivity curation, cached with its retrieval date — a loss is reported against the region's haploinsufficiency score and a
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which copy-number file in this project, by name. Unset, it is the project's only one — and it refuses rather than guessing when there is more than one. |
| data_set | string | no | which data set to scan, by name. Unset is the file's FIRST, which is what the panel opens on. |
| build | string | no | which assembly's curated region list to place the calls on. Unset is the build THIS FILE states about itself, and the node refuses rather than guessing when it states none — a region is a pair of coor |
| regions | string | no | a BED region file in this project, by name, to check against INSTEAD of ClinGen's curated list — the laboratory's own panel, which is what ChAS calls the CytoRegion file. Unset is ClinGen. A BED line |
| min_markers | number | no | ignore any call shorter than this many markers. The default counts everything the file called, because a reporting floor belongs to the laboratory and not to this tool — and it is the same floor copy_ |
| min_bases | number | no | ignore any call spanning fewer bases than this. Default 0, for the same reason as min_markers. Note a single-marker call spans 0 bases. |
| _subject | object | 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. |
| _files | array | 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. |
Read an Affymetrix array result's own somatic-mutation calls: one row per mutation probe set with the producer's call, the score behind it and the two thresholds that call was graded against. OncoScan CNV Plus states this table; CytoScan and SNP 6.0 results do not, and the tool says so rather than answering empty.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which copy-number file in this project, by name. Unset, it is the project's only one — and it refuses rather than guessing when there are several. |
| detected_only | boolean | no | report only the calls the producer detected. Default false: the undetected rows are what say the probe set was READ and came back wild type, which is a different answer from the probe set being absent |
| _subject | object | 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. |
| _files | array | 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. |
Read an Affymetrix array result's own allele-specific copy number: for each segment the major and minor allele counts (1+1, 2+0, 0+0), what they mean (balanced, allelic imbalance, loss of heterozygosity placed against the sample's own ploidy, homozygous deletion), and ASCAT's whole-genome summary over them (LOH fraction, homozygous deletions, modal allele state, whole-genome doubling, genomic inst
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which copy-number file in this project, by name. Unset, it is the project's only one, and it refuses rather than guessing when there are several. |
| estimated_only | boolean | no | report only the segments the producer split. Default false: an unestimated segment is listed as such, which is a different answer from its absence. |
| _subject | object | 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. |
| _files | array | 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. |
Recompute loss of heterozygosity from an Affymetrix array's own per-marker genotype calls, rather than reading the runs the producer wrote: APT's window method, with the false-positive rate and the assumed genotyping error rate as parameters. Answers where a sample has lost one parental haplotype, including where copy number is normal. Needs a container that states genotype calls — an OncoScan OSC
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which copy-number file in this project, by name. Unset, it is the project's only one — and it refuses rather than guessing when there are several. |
| alpha | number | no | APT's lohCN_alpha: the false-positive rate the heterozygote cutoff is set against. Raising it makes the window narrower and the method readier to call a run, which is the knob to move when comparing |
| error_rate | number | no | APT's lohCN_errorrate: the assumed genotyping error rate, which is what makes a heterozygote inside a homozygous stretch explicable. It is RE-ESTIMATED from the sample's own no-call rate when the ge |
| min_genomic_span | number | no | APT's lohCN_minGenomicSpan: a called run narrower than this many base pairs is dropped. The default is the vendor's 1,000,000. |
| _subject | object | 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. |
| _files | array | 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. |
Join two Affymetrix copy-number samples' own calls and report which events they share and which only one of them carries: for every pair, the chromosome both files resolved to, the kind, the bases they overlap and their reciprocal overlap; and separately each sample's unshared calls. Kind is part of the match, so a gain in one sample and a loss in the other at one locus are reported as two unshare
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which copy-number file in this project is the first sample, by name. Unset, it is the project's only one — and it refuses rather than guessing when there is more than one. |
| data_set | string | no | which data set of the first file to scan, by name. Unset is the file's FIRST, which is what the panel opens on. |
| compare | string | yes | which copy-number file in this project is the second sample, by name — the same parameter copy_number_read.compare takes. Required: there is no default second sample, and a file compared with itself a |
| compare_data_set | string | no | which data set of the second file to scan. Unset is that file's FIRST. |
| min_markers | number | no | ignore any call shorter than this many markers, on BOTH sides. The default counts everything either file called, because a reporting floor belongs to the laboratory and not to this tool — and it is th |
| min_bases | number | no | ignore any call spanning fewer bases than this, on BOTH sides. Default 0, for the same reason as min_markers. Note a single-marker call spans 0 bases. |
| _subject | object | 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. |
| _files | array | 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. |
Estimate which mosaic fraction class each region of one chromosome is closest to, as Affymetrix Power Tools computes it. A mosaic event is present in only some of the sample's cells, so its log2 ratio sits between the levels a clonal change would produce. Every segment comes back with the class it was assigned (±0.3, ±0.5, ±0.7, ±1.0), the fraction that class is NAMED for, its confidence, and whet
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which copy-number file in this project, by name. Unset, it is the project's only one — and it refuses rather than guessing when there is more than one. |
| data_set | string | no | which data set to read, by name. Unset is the file's FIRST, which is what the panel opens on. |
| chromosome | number | no | which chromosome, as the file numbers them (1-22, then 23=X, 24=Y, 25=MT — the file's own convention). Unset is the first the index carries. A chromosome too short for the method is refused with the c |
| graph | string | no | which graph column to read. Unset is the first log2-ratio column, the same rule copy_number_segment applies. A column that is not a log2 ratio is refused rather than smoothed: a copy-number STATE colu |
| mosaic_bandwidth | number | no | the smoothing window in markers — APT's own marker-bandwidth. A mosaic event is a shallow wide elevation, so this is what decides how wide 'wide' is. The default is the vendor's shipped value. |
| mosaic_confidence_window | number | no | the running-median window used to score a segment, in markers — APT's own confidence-window. The default is the vendor's shipped value. |
| _subject | object | 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. |
| _files | array | 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. |
Plan the cycling programme for an amplicon on a NAMED enzyme, and check the reaction against that manufacturer's own published limits. The extension rate and the denaturation step come from the product's datasheet and protocol manual; the annealing temperature is yours (from design_primers or pcr_amplify), and anything the manufacturer does not publish comes from the pydna-faithful Taq or Phusion/
| Parameter | Type | Required | Notes |
|---|---|---|---|
| amplicon_bp | number | yes | product length [bp] — pcr_amplify and design_primers both emit it. |
| gc_percent | number | yes | product GC [%], which decides whether the vendor's GC window is cleared. In %. |
| anneal_c | number | yes | annealing temperature [°C] for the pair — the Ta the Tm model gave you, not a guess this tool makes. In °C. |
| polymerase | string | no | which annealing convention and which preset supplies whatever the datasheet does not. Values: taq (Taq), dbd (Phusion / Q5 (DNA-binding domain)). |
| enzyme | string | no | the cataloged product to plan on, or generic for the preset alone. Its datasheet supplies the extension rate and, where its manual states one, the denaturation step. Values: generic (Generic preset |
| cycles | number | no | cycles in the main block. |
| steps | string | no | 3-step keeps a separate annealing stage; 2-step merges it into the extension, which is what a high-Tm pair allows. auto lets the builder decide from the primer Tms. Advanced. |
| touchdown | boolean | no | start with a touchdown block: the annealing temperature starts high and drops each cycle to the Ta, so early cycles favor the specific product (Korbie & Mattick 2008). |
| touchdown_delta_c | number | no | how far the annealing temperature drops per touchdown cycle. In °C. Only applies when touchdown is true. |
| touchdown_cycles | number | no | touchdown cycles before the main block (they add to totalCycles). Only applies when touchdown is true. |
| _subject | object | 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. |
| _files | array | 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. |
Read a variant call set (VCF, bgzipped VCF or BCF) in this project and return the records matching a query: a locus, a variant class, a QUAL floor, PASS-only, a sample that is not hom-ref, or an INFO key. Every answer says what it read over and what it filtered on, so a count can never be mistaken for the file's total. A call set too large to read whole opens at its header, and a locus is then the
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which call set in this project, by name. Unset, it is the project's only one, and it refuses rather than guessing when there is more than one. |
| contig | string | no | restrict to one contig, named as the FILE names it: 20 and chr20 are different names and neither is normalized into the other. With start/end this is a locus read; alone it is the whole contig |
| start | number | no | first base of the region, 1-based and inclusive, as VCF itself counts. Needs contig. Unset is the contig's first record. |
| end | number | no | last base of the region, 1-based and inclusive. Needs contig. Unset is the contig's last record. |
| types | array | no | keep only these variant classes. The classes are htslib's own, assigned by the ported setVariantType and identical to the ones the panel's type filter offers. Unset keeps every class. |
| min_qual | number | no | keep only records whose QUAL is at least this. A record stating no QUAL (.) is DROPPED unless include_missing_qual is on, because a missing score is not a passing one. |
| include_missing_qual | boolean | no | keep records that state no QUAL when min_qual is set. Off by default: a caller asking for a quality floor is asking about scores, and a record with none has not met it. |
| pass_only | boolean | no | keep only records whose FILTER is PASS or unset (.): the usual first question of a call set, and the one filter that changes what most downstream steps should see. |
| sample | string | no | keep only records where this sample's genotype is neither hom-ref nor missing, which is that sample's own variants out of a cohort. Named as the file's header names it. |
| info_key | string | no | keep only records carrying this INFO key; with info_value, only those where it equals that value. |
| info_value | string | no | with info_key, the value that key must equal. |
| limit | number | no | how many matching records to return. The COUNT is always the full number of matches: this caps the rows, never the accounting. |
| _subject | object | 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. |
| _files | array | 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. |
Summarize a variant call set the way bcftools stats does: records by class, transitions and transversions with their ratio, the twelve directed substitutions, indel lengths, per-contig counts, the FILTER tally, the QUAL range, and per-sample genotype counts. Reports what could NOT be counted rather than leaving a zero standing in for it, meaning a file whose genotypes were not parsed, and any geno
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which call set in this project, by name. Unset, it is the project's only one, and it refuses rather than guessing when there is more than one. |
| contig | string | no | summarize ONE contig instead of the whole file, named as the file names it. The per-contig table is always over everything read; this narrows what everything else counts. |
| pass_only | boolean | no | count only records whose FILTER is PASS or unset. A Ts/Tv computed over unfiltered calls and one computed over passing calls are different measurements, and this is which one you asked for. |
| _subject | object | 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. |
| _files | array | 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. |
Annotate every call in a VCF or BCF in this project against the transcripts of a GenBank reference: the Sequence Ontology term per transcript, Ensembl's IMPACT, HGVS c. and p., the CDS and protein positions, and the distance for an upstream, downstream or intronic call. Each call's most severe consequence is picked by Ensembl's own ranking. A symbolic allele, or a REF the reference does not carry
| Parameter | Type | Required | Notes |
|---|---|---|---|
| file | string | no | which call set in this project, by name. Unset, it is the project's only one, and it refuses rather than guessing when there is more than one. |
| reference | string | no | the GenBank file the calls were made against, by name. Unset, every GenBank file in the project is a candidate: one is used for every call, several are matched to each call by its CHROM (accession or |
| offset | number | no | the coordinate the reference's FIRST base has in the call set's contig. Default 1, the reference is the whole contig; a region cut out of a genome sets where it was cut from. |
| up_down_stream_bp | number | no | how far from a transcript a call still counts as upstream or downstream of it. SnpEff’s own default is 5,000; the window decides how many annotations each call gets. In bp. |
| min_impact | string | no | keep only calls whose most severe consequence is rated at least this. Unset keeps every call. |
| limit | number | no | how many calls to return in calls; the counts are always of all of them. Advanced. |
| _subject | object | 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. |
| _files | array | 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. |
Substitute one called ALT allele into a sequence and return the edited bases, the range the edit occupies and the length change. The REF allele is checked against the sequence first and a mismatch REFUSES naming both: applying a call from a different assembly would produce a construct that looks fine and is wrong. Symbolic and breakend alleles are refused for what they are: they name a rearrangeme
| Parameter | Type | Required | Notes |
|---|---|---|---|
| sequence | string | yes | the sequence to edit. |
| file | string | no | which call set the variant comes from, by name. Unset, it is the project's only one. |
| contig | string | yes | the contig of the record to apply, as the file names it. |
| pos | number | yes | the POS of the record to apply, 1-based as VCF writes it. |
| alt_index | number | no | which ALT of a multiallelic record to apply, counting from 1 as the file lists them. Default the first. |
| offset | number | no | the coordinate this sequence's FIRST base has in the call set's contig. Default 1, meaning the sequence starts at the contig's start. A plasmid extracted from a genome sets this to where it was cut fr |
| _subject | object | 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. |
| _files | array | 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. |
The authoritative databases available, with what each one covers, whether it is reachable from the browser, and any license or coverage caveat. Call this before searching if unsure which source answers a question.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| domain | string | no | restrict to one subject area (all areas when unset). |
| _subject | object | 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. |
| _files | array | 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. |
Look up a gene or genomic region: NCBI Gene records, HGNC nomenclature, Ensembl records, cross-references, MyGene identifiers, UCSC assembly data, GTEx expression, or BioMart tables.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | yes | which authority to ask. |
| query | string | yes | a gene symbol or identifier (e.g. "BRCA2"), or a command such as "ensembl_lookup:BRCA2" or "ensembl_xrefs:ENSG00000139618". |
| limit | number | no | maximum records (1–20). |
| _subject | object | 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. |
| _files | array | 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. |
Look up a variant: ClinVar clinical interpretation, dbSNP records, gnomAD population frequency and gene constraint, CADD deleteriousness, or GWAS/eQTL associations.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | yes | which authority to ask. |
| query | string | yes | an rsID, HGVS or chrom-pos-ref-alt id, or a command such as "get_variant:variant_id=19-44908822-C-T" or "gene_constraint:gene_symbol=BRCA2". The eQTL Catalogue is the exception and needs a LOCUS, beca |
| limit | number | no | maximum records (1–20). |
| _subject | object | 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. |
| _files | array | 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. |
Look up a protein: UniProt records, InterPro/Pfam domain architecture, STRING interaction networks, Human Protein Atlas expression, or a predicted/experimental structure from AlphaFold, PDB or EMDB.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | yes | which authority to ask. |
| query | string | yes | an accession or gene symbol, or a command such as "get_domain_architecture:P04637" or "get_string_network:TP53,BRCA1 species=9606". A PLAIN UniProt search returns metadata only and never the residues |
| limit | number | no | maximum records (1–20). |
| _subject | object | 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. |
| _files | array | 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. |
Look up a chemical compound or drug: ChEMBL molecules, mechanisms of action and bioactivity, PubChem properties, ChEBI ontology, Rhea reactions, or purchasable ZINC compounds.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | yes | which authority to ask. |
| query | string | yes | a compound name, SMILES or identifier, or a command such as "mechanism:CHEMBL941" or "admet:CHEMBL941". |
| limit | number | no | maximum records (1–20). |
| _subject | object | 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. |
| _files | array | 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. |
Look up clinical and translational evidence: ClinicalTrials.gov trials, FDA labels and adverse events, Open Targets associations, CIViC cancer variant evidence, ClinGen curation, cBioPortal cohorts, or DepMap dependencies.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | yes | which authority to ask. |
| query | string | yes | a drug, gene, disease or trial id, or a command such as "clingen_gene_validity:BRCA2". |
| limit | number | no | maximum records (1–20). |
| _subject | object | 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. |
| _files | array | 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. |
Search the published literature: PubMed, Europe PMC (including open-access full-text sections), OpenAlex, Crossref, arXiv, bioRxiv/medRxiv preprints or DataCite datasets.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | yes | which authority to ask. |
| query | string | yes | search terms, or a command such as "pmid:35486828", "fulltext:PMC9046468" or "openalex_search_works:CRISPR". |
| limit | number | no | maximum records (1–20). |
| _subject | object | 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. |
| _files | array | 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. |
Look up omics and regulation records: GEO and ArrayExpress experiments, PRIDE proteomics, MetaboLights, MGnify, ENCODE experiments and files, JASPAR motifs, or UniBind TF binding sites.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | yes | which authority to ask. |
| query | string | yes | an accession or search term, or a command such as "geo_get_series:GSE12345" or "encode_get_file:ENCFF002JUR". |
| limit | number | no | maximum records (1–20). |
| _subject | object | 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. |
| _files | array | 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. |
Resolve an ontology term, taxon, pathway or cell type: OLS ontologies, NCBI Taxonomy, QuickGO annotations, Reactome pathways, KEGG entries, Rfam RNA families, CellGuide/PanglaoDB cell types and markers, an antibody RRID, or an identifiers.org prefix and the pattern its ids follow.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | yes | which authority to ask. |
| query | string | yes | a term, accession or command such as "get_go_annotations:P04637" or "map_reactome_pathways:TP53". |
| limit | number | no | maximum records (1–20). |
| _subject | object | 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. |
| _files | array | 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. |
Assess a small molecule given as SMILES or a molfile: RDKit's descriptors, medchem's drug-likeness rules (Lipinski, Veber, Ghose, Egan, REOS, rule of three, CNS and more) and the papers' own readings where medchem departs from them, with every bound and this molecule's value, a structural-alert screen (PAINS, Brenk, NIH, ZINC and ChEMBL's seven curated sets) with the matched atoms, the molecular f
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecule | string | yes | the structure: a SMILES string or an MDL molfile (V2000 or V3000). One molecule; for an SDF, pass one record. |
| rules | array | no | which drug-likeness rules to evaluate, by id: medchem's 17, plus the papers' own readings of Lipinski, Ghose and REOS (ids ending _paper). Every rule by default. |
| alert_sets | array | no | which structural-alert catalogs to screen against. Empty screens nothing, which is not a clean result. |
| _subject | object | 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. |
| _files | array | 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. |
How similar two small molecules are: Tanimoto under six RDKit fingerprints (Morgan/ECFP4, atom pair, topological torsion, RDKit path, pattern, MACCS), every DataStructs metric (Tanimoto, Dice, cosine, Sokal, Russell, Rogot-Goldberg, all-bit, Kulczynski, McConnaughey, asymmetric, Braun-Blanquet, on-bit, Tversky) on the chosen one, and count-based Tanimoto, Dice and Tversky on Morgan counts. The fir
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecule | string | yes | the query structure: SMILES or a molfile. |
| other | string | yes | the structure to compare it with: SMILES or a molfile. |
| fingerprint | string | no | the fingerprint every metric is read on. Values: morgan (Morgan (ECFP4)), atomPair (Atom pair), torsion (Topological torsion), path (RDKit path), pattern (Pattern), maccs (MACCS keys). |
| tversky_a | number | no | Tversky's weight on bits only the query has, 0–1. |
| tversky_b | number | no | Tversky's weight on bits only the other has, 0–1. |
| _subject | object | 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. |
| _files | array | 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. |
Enumerate a small molecule's protonation states across a pH window with Dimorphite-DL (Ropp et al. 2019): each ionisable group it recognizes (substructures with pKa means and spreads taken from measured pKa values) is kept protonated, deprotonated or both, and every combination is returned as SMILES. Reproduces Dimorphite-DL 2.1.0, including that it neutralizes charged groups first and keeps only
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecule | string | yes | the structure: SMILES or a molfile. |
| ph_min | number | no | lower end of the pH window. |
| ph_max | number | no | upper end of the pH window. |
| precision | number | no | how many standard deviations of each group's pKa widen its window, 0–10. |
| max_variants | number | no | stop enumerating past this many states (later groups are then not visited). |
| _subject | object | 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. |
| _files | array | 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. |
Which of a list of small molecules contain a SMARTS substructure, with RDKit's substructure library (pattern-fingerprint screen, then atom matching). Returns the 0-based indices of the hits and of any structure RDKit could not read.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecules | array | yes | the library: one SMILES or molfile per entry. |
| smarts | string | yes | the substructure, as SMARTS (a plain SMILES reads as one). |
| _subject | object | 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. |
| _files | array | 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. |
Screen every structure of a library at once against drug-likeness rules and structural-alert catalogs, as the library grid does, and bin one rule property across it, split at the bound of a chosen rule. Returns, per 0-based structure, the rules it breaks and the alerts it trips, and the binned distribution with how many structures fall within the bound.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecules | array | yes | the library: one SMILES or molfile per entry. |
| rules | array | no | which drug-likeness rules to screen, by id. Every rule by default. |
| alert_sets | array | no | which structural-alert catalogs to screen against. Empty screens nothing. |
| property | string | no | the rule property to bin, at the value the rules judged. Values: mw (Monoisotopic mass), clogp (cLogP (Crippen)), hbd (H-bond donors), hba (H-bond acceptors), lipinskiHbd (Lipinski donors (NH + OH)), |
| split_rule | string | no | the rule whose bound on that property splits each bar; the first screened rule bounding it by default. Values: rule_of_five (Lipinski rule of five), rule_of_five_beyond (Beyond rule of five), rule_of_ |
| bins | number | no | how many bins. |
| _subject | object | 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. |
| _files | array | 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. |
A small molecule's tautomers and the canonical one, as RDKit's TautomerEnumerator finds and scores them: 37 hydrogen-shift transforms (after MolVS and Sitzmann 2010), scored by aromatic rings, twelve weighted groups and hydrogens on P, S, Se and Te, ties to the smaller SMILES. Returns every tautomer, the canonical SMILES, the score and the 0-based atoms (implicit hydrogens, molfile order) a hydrog
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecule | string | yes | the structure: SMILES or a molfile. |
| max_tautomers | number | no | stop the enumeration at this many tautomers. |
| max_transforms | number | no | stop after this many transform applications. |
| _subject | object | 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. |
| _files | array | 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. |
Run a reaction SMARTS over lists of reactants, every combination, with RDKit's reaction engine: one list per reactant template, in template order. Pick one of 94 library reactions (the 58 robust organic reactions of Hartenfeller et al. 2011 and 36 click-chemistry reactions, as AutoGrow4 encodes them) or pass your own SMARTS. Each product is sanitised; a product set is kept only when every product
| Parameter | Type | Required | Notes |
|---|---|---|---|
| template | string | no | the library reaction to run, or custom for your own SMARTS. |
| smarts | string | no | your own reaction SMARTS, reactants>>products. Only applies when template is custom. |
| reactants | array | yes | one list of SMILES or molfiles per reactant template, in template order. |
| max_combinations | number | no | stop after this many reactant combinations. |
| _subject | object | 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. |
| _files | array | 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. |
Write a list of small molecules as one file: SDF (V2000 or V3000), each record named and, optionally, carrying its canonical SMILES and RDKit descriptors as data fields; or SMILES or CXSMILES, one record a line followed by its name. Written as RDKit's SDWriter, MolToSmiles and MolToCXSmiles write it; a structure RDKit cannot read is left out and its index returned.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecules | array | yes | the structures: one SMILES or molfile per entry. |
| names | array | no | a name per structure, in the same order (the SDF title line, the SMILES second column). |
| format | string | no | the file format. Values: sdf (SDF), sdf-v3000 (SDF V3000), smiles (SMILES), cxsmiles (CXSMILES). |
| with_properties | boolean | no | SDF only: add canonical_smiles and the RDKit descriptors to each record as data fields. |
| _subject | object | 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. |
| _files | array | 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. |
Cluster or diversity-pick a list of small molecules on 1 − Tanimoto of Morgan radius-2 fingerprints: Butina sphere exclusion (RDKit ClusterData, optional reordering), MaxMin diversity picking (RDKit MaxMinPicker, seeded), or average linkage (UPGMA) cut into k clusters. Indices are 0-based.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecules | array | yes | the structures: one SMILES or molfile per entry. |
| method | string | no | the clustering method. Values: butina (Butina (sphere exclusion)), maxmin (MaxMin diversity pick), average (Average linkage (UPGMA)). |
| threshold | number | no | Butina: neighbors within this distance (1 − Tanimoto), 0–1. |
| reordering | boolean | no | Butina: recount unassigned neighbors after each cluster. |
| picks | number | no | MaxMin: how many structures to pick. |
| seed | number | no | MaxMin: seed of the first pick, as RDKit's seed. |
| clusters | number | no | average linkage: how many clusters to cut the tree into. |
| _subject | object | 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. |
| _files | array | 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. |
Principal components of a list of small molecules, computed as R's prcomp computes them, on the scaled property table or on Morgan radius-2 bits: each structure's scores on PC1 and PC2, every component's standard deviation and variance share, the property loadings, and constant properties left out. Indices are 0-based.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecules | array | yes | the structures: one SMILES or molfile per entry. |
| space | string | no | what the components are taken over. Values: descriptors (Properties (scaled)), morgan (Morgan bits (ECFP4)). |
| _subject | object | 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. |
| _files | array | 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. |
The scaffold network (Kruger et al. 2020) of a list of small molecules, as RDKit's CreateScaffoldNetwork builds it, under RDKit's default ring-side cuts or the 46 BRICS bond types (Degen 2008). Every node with the structures that contain it and how many times the network made it, and every edge with RDKit's type. Structures over the cut limit are named and left out. Indices are 0-based.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecules | array | yes | the structures: one SMILES or molfile per entry. |
| rules | string | no | which bonds are cut. Values: rings (Ring side of each cut), brics (BRICS, both sides). |
| _subject | object | 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. |
| _files | array | 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. |
RDKit's R-group decomposition of a list of small molecules on a core given as SMARTS (default RGroupDecomposition parameters): per matched structure its core and substituents R1, R2 …, and the structures the core does not match. Indices are 0-based.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecules | array | yes | the structures: one SMILES or molfile per entry. |
| core | string | yes | the core, as SMARTS. |
| _subject | object | 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. |
| _files | array | 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. |
Matched molecular pairs (Hussain & Rea 2010) in a list of small molecules, as mmpdb finds them: pairs that differ by one change no larger than a heavy-atom limit, grouped by the change as a reaction SMIRKS, most pairs first. Indices are 0-based.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecules | array | yes | the structures: one SMILES or molfile per entry. |
| max_size | number | no | largest changed part, in heavy atoms. |
| _subject | object | 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. |
| _files | array | 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. |
SALI activity cliffs (Guha & Van Drie 2008) in a list of small molecules with one activity each: every pair scored as the activity difference over one minus the Tanimoto similarity of RDKit path fingerprints, steepest first; identical fingerprints with different activities score Infinity. Indices are 0-based.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecules | array | yes | the structures: one SMILES or molfile per entry. |
| activities | array | yes | one number per structure, in the same order; a non-number leaves it out. |
| scale | string | no | how the activities are read. Values: pIc50Um (pIC50 from a µM IC50), asGiven (As given). |
| _subject | object | 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. |
| _files | array | 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. |
3D conformers of a small molecule by OpenChemLib's torsion-library generator, each scored and optionally minimized under MMFF94, MMFF94s or MMFF94s+ (whose MMFF94 equals Halgren's OPTIMOL on all 761 validation-suite structures), lowest energy first, as molfiles with every hydrogen; for a 3D molfile also the energy of its own geometry. Energies in kcal/mol.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| molecule | string | yes | the structure: SMILES or a molfile. |
| count | number | no | at most this many conformers. |
| seed | number | no | random seed. |
| strategy | string | no | how torsion sets are chosen. |
| max_torsion_sets | number | no | distinct torsion sets to try before stopping. |
| sixty_degree_steps | boolean | no | every rotatable bond in 60° steps instead of the torsion library's angles. |
| force_field | string | no | the MMFF94 variant. |
| minimise | boolean | no | minimize each conformer. |
| max_iterations | number | no | minimiser iterations, at most. |
| gradient_tolerance | number | no | minimiser gradient tolerance. |
| energy_tolerance | number | no | minimiser energy tolerance. |
| _subject | object | 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. |
| _files | array | 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. |
Predict which reactant atom each product atom came from (atom-to-atom mapping) with RXNMapper (Schwaller et al., Sci. Adv. 2021), the most accurate mapper in Lin et al.'s 2022 benchmark of 1,851 curated reactions. Agents join the reactants, each compound is canonicalised and each side sorted before mapping, as RXNMapper does. Returns the reaction SMILES with atom maps and a confidence (the product
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reaction | string | yes | reaction SMILES, reactants>agents>products; existing atom maps are ignored. |
| _subject | object | 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. |
| _files | array | 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. |
Fill Addgene's own deposit spreadsheet from a record: one row per plasmid with its name and sequence, plus your answers for every plasmid (purpose, plasmid type, cloning method, resistance, growth strain and the other drop-downs). The sheet is fetched from Addgene each run, so its columns and choices are current; a value it would refuse is left out and named, and columns lists every column with
| Parameter | Type | Required | Notes |
|---|---|---|---|
| genbank | string | yes | the plasmids to deposit, as GenBank text: one row per nucleotide record. |
| answers | object | no | the sheet's columns to fill for every plasmid, header → value, e.g. {"Purpose": "Expresses EGFP in E. coli", "Bacterial Resistance": "Ampicillin"}. A drop-down column takes one of its own choices; run |
| _subject | object | 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. |
| _files | array | 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. |
- Every tool — any call limit is its publisher’s, not ours
- No card, and mcprush charges nothing for it
- Runs at its publisher’s own address — this marketplace is not in the path
- Nothing to cap, because mcprush bills nothing
What counts against your monthly calls
| Tool | Unit | Calls used | Out of the allowance |
|---|
Nothing here is billable: mcprush charges nothing to install Jean — Molecular Biology & Genomics or to call it, at any volume.
Two independent axes, because powerful and malicious are different questions. The grade is threat only. The capability level is blast radius, and it is never a penalty on the grade — it is priced as one subtract-only term in the score, where you can see it.
This listing is an address its publisher runs, and you connect to it directly — this marketplace is not in the path. The scanner reads packages and public source, and an address is neither. So there is no grade — not a withheld one, an unmeasured one.
Release history
This is an address its publisher runs: which release it serves is theirs to choose, so there is nothing here to pin. The history below is for reading; the current release on file is 2.0.0.
No release note was published with this version.
One review per account, from a signed-in account that does not publish this listing. Nothing else is asked — you can say what you think before you install it. Publishers can reply once per review, and a review can be edited or deleted by whoever wrote it.
Any signed-in account that does not publish Jean — Molecular Biology & Genomics can review it, once — before installing it or after. A review from an account that has installed it is marked as one.
Nobody has reviewed this listing. The rating on the card is the mean of the reviews written here and nothing else, so there is no rating until somebody writes the first — which takes a signed-in account that does not publish it, and nothing else.