Jean — Molecular Biology & Genomics
Server Details
Validated molecular biology tools: cloning, primers, CRISPR, Sanger, alignment, qPCR, phylogenetics
- Status
- Healthy
- Uptime
- 100.0% over the last 24 hours
- Last Tested
- Transport
- Streamable HTTP · MCP 2025-11-25
- URL
- ChatGPT
- –
- Claude
- –
TDQS
Scored across 325 tools
Descriptions are unusually explicit about distinctions (e.g. the three melt-curve engines, 'neither of which is a fallback for another'), which rescues a lot. But with 325 tools many clusters are genuinely confusable at selection time: six BLAST-family tools (blast_search, blast_project_sequences, delta_blast_smart, rps_blast_cdd, rps_blast_smart, rpstblastn_smart), eight primer designers, six CRISPR scoring/off-target tools, and a large copy-number_Affymetrix family that an agent must read carefully to pick between.
Snake_case throughout, and most names are verb_noun (design_primer_pairs, check_manufacturability, quantify_base_editing, export_tree). Deviations exist where names are noun phrases instead (activity_cliffs, protein_properties, gc_content, antibody_isotype, alignment_redundancy), but they remain readable and predictable enough to navigate.
325 tools is an extreme mismatch for a single server: even though each is plausibly scoped to a subdomain, the surface is far beyond the 3-15 range where an agent can reason about the set. Selection burdens, near-duplicates across subdomains, and the need for meta-tools (plan_next_tools, describe_tools, read_answer_window) to navigate it all signal overscoping.
Coverage is exceptional end-to-end: sequence I/O, cloning/assembly with reports, primer and CRISPR design through ordering sheets, Sanger trace editing, NGS QC/mapping/variant calling, qPCR statistics, phylogenetics, proteomics/MS, chemoinformatics, and population genetics, with submission builders and export writers closing the lifecycle. Almost no obvious dead ends for a molecular-biology workflow.
Available Tools
325 toolsactivity_cliffsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| scale | No | how the activities are read. Values: pIc50Um (pIC50 from a µM IC50), asGiven (As given). | pIc50Um |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| molecules | Yes | the structures: one SMILES or molfile per entry. | |
| activities | Yes | one number per structure, in the same order; a non-number leaves it out. |
Output Schema
| Name | Required | Description |
|---|---|---|
| pairs | Yes | every pair, highest SALI first: i the more active, j, similarity, SALI |
| summary | Yes | the cliffs in words, generated from this run |
add_notebook_figureAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| tab | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| caption | 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. | |
| drawing | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| entry_id | No | append to this entry instead of the open one; with neither, a new entry is started and named after the drawing. |
Output Schema
| Name | Required | Description |
|---|---|---|
| figure | Yes | its figure number in that entry, as the preview and every export print it |
| caption | Yes | the caption written |
| entry_id | Yes | the entry the figure went into |
adopt_trace_callsAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | 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` derive them and write a two-base IUB code where a second allele is present, differing only in whether the two are assumed equal in amount. | rescore |
| table | No | the instrument and polymer the quality scale was calibrated on. There is no universal default: a base scores differently under a different table. | 3730pop7 |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| min_ratio | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| bases | Yes | how many bases the read carries after the adoption |
| sequence | Yes | the read the document now carries, trimmed and with manual calls applied |
| basesBefore | Yes | how many it carried before it, so a gate can see the read change length |
| everythingPlaced | Yes | false when any annotation end sat on a call the new reading does not make, so it was placed at its nearest neighbor. Wire it into a gate before trusting a boundary |
alignment_agreementARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| locus | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| variants | 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. | |
| alignment | 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 | 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 then only the window and its annotation are reported. | |
| gene_track | 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 — RefSeq Curated does. Values: ncbiRefSeqSelect (RefSeq Select and MANE), ncbiRefSeqCurated (RefSeq Curated), ncbiRefSeq (RefSeq All), ncbiRefSeqPredicted (RefSeq Predicted). | ncbiRefSeqSelect |
Output Schema
| Name | Required | Description |
|---|---|---|
| rate | Yes | differing aligned bases as a fraction of compared ones, 0 when nothing matched up |
| genes | Yes | the RefSeq models overlapping the window: symbol, accession, strand and bounds, as UCSC states them |
| reads | Yes | reads read for the window |
| noCall | Yes | aligned bases where one side is N — counted as neither, which is where this differs from an aligner's NM |
| window | Yes | the window actually measured, as a locus string |
| cautions | Yes | what this run earned: a reference whose length disagrees with the one the file declares, no-call bases counted as neither, and the window the numbers describe |
| compared | Yes | aligned bases that had a reference base to compare against — the denominator |
| variants | Yes | the dbSNP records in the window when asked for: rsID, alleles, class, highest reported frequency and ClinVar significance |
| conclusion | Yes | the reading in one sentence, generated from this run — the panel's own words |
| mismatched | Yes | of those, how many differ |
| pathogenic | Yes | how many of those ClinVar calls pathogenic |
alignment_pcaARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | the ALIGNED rows, each {name, aligned}. Wire `alignedSequences` from align_sequences. | |
| model | 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). | PID |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| components | No | how many leading components to report per row. |
Output Schema
| Name | Required | Description |
|---|---|---|
| summary | Yes | the model, the leading eigenvalues and their share of the total |
| similarity | Yes | the pairwise similarity matrix the analysis decomposed, rows in alignment order |
| coordinates | Yes | each row's coordinates on the leading components, {name, pc: [PC1, PC2, …]} |
| eigenvalues | Yes | every eigenvalue, largest first |
alignment_redundancyARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | last column compared, 1-based inclusive; 0 means the last column. Advanced. | |
| from | No | first column compared, 1-based inclusive. Advanced. | |
| rows | Yes | the ALIGNED rows, each {name, aligned}. Wire `alignedSequences` from align_sequences. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| threshold | No | percent identity at or above which a row is redundant. In %. |
Output Schema
| Name | Required | Description |
|---|---|---|
| kept | Yes | the names of the rows that survive the filter, in alignment order |
| rows | Yes | every row's redundancy, {name, identity}, in alignment order |
| summary | Yes | how many rows are redundant at the threshold, and which |
| redundant | Yes | the redundant rows, each {name, identity}, most redundant first |
alignment_windowARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| locus | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| min_mapq | 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. | |
| alignment | 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. | |
| max_reads | 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. | |
| hide_secondary | No | drop secondary alignments (FLAG 0x100). | |
| hide_duplicates | No | drop reads marked as PCR or optical duplicates (FLAG 0x400). | |
| hide_supplementary | No | drop supplementary alignments (FLAG 0x800). |
Output Schema
| Name | Required | Description |
|---|---|---|
| reads | Yes | the reads in the window after filters: name, reference, 1-based start and end, strand, MAPQ, CIGAR, TLEN and sequence — the shape an alignment or a screen takes |
| hidden | Yes | reads in the window the filters removed — 0 with an active filter is a real answer |
| window | Yes | the window actually read, as a locus string |
| sampled | Yes | more reads overlap the window than the cap allows, so `reads` is an even sample rather than all of them |
| coverage | Yes | the depth profile as bins across the window, in order |
| depthPlot | Yes | the coverage track as the pileup draws it: each bin's lowest, mean and highest per-base depth over ALL reads, so a dropout narrower than a bin still shows in the minimum |
| depth_max | Yes | the deepest bin |
| depth_mean | Yes | mean depth across the window’s coverage bins, over ALL reads — the coverage track is full-depth, as BamView’s is, so filters do not move it |
| read_count | Yes | how many reads that is |
| insert_size | Yes | the |TLEN| band this library’s own proper pairs define — `min`, `max` and whether it was MEASURED here or is the untuned fallback, which is what decides whether an insert is abnormal |
align_readARead-onlyInspect
Pairwise-align ONE sequencing read against a reference and hand on the two gapped rows, so the read can be graded.
| Name | Required | Description | Default |
|---|---|---|---|
| read | Yes | the read's bases — wire a trace reader's `sequence` output here, or paste them. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| reference | 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). |
Output Schema
| Name | Required | Description |
|---|---|---|
| columns | Yes | the alignment's width, gaps included |
| identity | Yes | % identity over the columns where both rows have a base (gaps excluded) |
| mismatches | Yes | columns where the two rows carry different bases |
| alignedRead | Yes | the read with gaps inserted — wire into `verify_read.aligned_read` |
| referenceLength | Yes | the reference's ungapped length in bp — wire into `verify_read.target_len` |
| alignedReference | Yes | the reference with gaps inserted — wire into `verify_read.aligned_ref` |
align_sequencesBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| gap | No | `poa` only: score for a gap column. Negative. Only applies when engine is poa. Advanced. | |
| match | No | `poa` only: score for a pair of identical symbols. Only applies when engine is poa. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| engine | 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 the way Clustal and MUSCLE do. Each engine reads only its own parameters below. Values: poa (Partial-order (poapy) - reads over one locus), progressive (Progressive (biotite) - a family, guide-tree merged). | poa |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| gap_open | No | `progressive`, affine only: the penalty for STARTING a gap. Negative. Only applies when affine_gap is true. | |
| mismatch | No | `poa` only: score for a mismatching pair. Negative. Only applies when engine is poa. Advanced. | |
| sequences | No | the sequences to align — wire several upstream outputs here, or list library document names/ids. | |
| affine_gap | 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 when engine is progressive. | |
| gap_extend | 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 one long indel. Only applies when affine_gap is true. | |
| guide_tree | 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 the port reproduces byte-for-byte; neighbour-joining and BIONJ do not assume a molecular clock, so on sequences evolving at different rates they group by relatedness where UPGMA groups by raw similarity - which is exactly the case where the guide tree changes the alignment. Values: upgma (UPGMA (biotite's own)), nj (Neighbour-joining), bionj (BIONJ), wpgma (WPGMA). Only applies when engine is progressive. | upgma |
| gap_penalty | No | `progressive` only: the flat penalty per gap column. Negative. Only applies when affine_gap is false. | |
| align_matrix | 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 nucleotides, BLOSUM62 for protein. Naming the wrong one is not an error the engine can raise - BLOSUM62 reads A, C, G and T as alanine, cysteine, glycine and threonine and returns a number. Values: auto (Auto - from the alignment's alphabet), EDNAFULL (EDNAFULL - nucleotides (EMBOSS NUC.4.4)), BLOSUM62 (BLOSUM62 - amino acids). Only applies when engine is progressive. | auto |
| global_align | 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 part of a locus. Only applies when engine is poa. Advanced. | |
| score_matrix | 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 columns) - an honest absence rather than a score under a matrix that does not match the alphabet. Values: PAM250 (PAM250 - amino acids, greater evolutionary distance), BLOSUM62 (BLOSUM62 - amino acids), EDNAFULL (EDNAFULL - nucleotides). Advanced. | |
| include_subject | No | also align the node's subject (the open or wired record). | |
| terminal_penalty | 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. a read against a gene. Only applies when engine is progressive. |
Output Schema
| Name | Required | Description |
|---|---|---|
| fit | Yes | per row: its closest row in this alignment, their identity here, and the same pair's identity aligned on its own with free end gaps (biotite align_optimal) — the loss shows where the alignment holds a row out of register; `outliers` names the rows flagged. `{ ok: false, reason }` when the check could not run |
| rows | Yes | aligned rows (name + gapped sequence) |
| count | Yes | number of aligned sequences (excluding the consensus row) |
| engine | Yes | which aligner produced this alignment — `poa` or `progressive` |
| figure | Yes | the alignment's first 80 columns drawn as the MSA canvas opens on them: rows named, residues shaded by column identity, the conservation line under the block. draw_alignment draws any other window |
| length | Yes | alignment width in columns |
| scores | Yes | the pyMSA quality scores: summed entropy (nats, pyMSA's sign — negative), % non-gaps, % totally conserved columns, and the sum-of-pairs/star pair when a `score_matrix` was named |
| consensus | Yes | the per-column majority consensus (POA returns its own graph consensus row; the progressive engine has no graph, so the majority is the consensus for both) |
| conservation | Yes | the Clustal-style conservation line, one character per column — `*` where every row carries the same residue and the column is ungapped |
| guideTreeNewick | Yes | `progressive` only: the guide tree the merge followed, in Newick, labelled with the row names. Branch lengths are deliberately omitted — a guide tree's heights are a clustering artifact, not divergence estimates |
| alignedSequences | Yes | the aligned input rows only, excluding the generated consensus — wire this into build_tree |
analyze_flow_cytometryARead-onlyInspect
A flow cytometry list-mode file (FCS 2.0, 3.0 or 3.1) from the project, end to end: read and linearize every event ($PnE anti-log, $PnG gain, $TIMESTEP), compensate it with the spillover matrix the file declares, apply a Gating-ML 2.0 gating strategy from the project, and report every population with its event count, percent of parent and percent of all events, the mean, median, SD and CV of every channel in every population, a binned two-channel density for a plot, and a density-valley threshold on any channel (flowDensity deGate).
| Name | Required | Description | Default |
|---|---|---|---|
| A | No | additional negative decades. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| M | No | decades of the full scale. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| T | No | top of scale; empty means the file's largest fluorescence $PnR. | |
| W | No | linear width in decades. Only applies when scale is logicle or hyperlog or flowcore-logicle. | |
| bins | No | bins per axis of the density. | |
| scale | No | the display scale of the fluorescence channels (scatter and time stay linear): used for the plot, the threshold and, with `stats_on: scaled`, the statistics. Values: logicle (Logicle (Gating-ML 2.0, Moore & Parks)), fasinh (ArcSinh (Gating-ML 2.0 fasinh)), arcsinh (ArcSinh with a cofactor (asinh(x / c), Cytobank and CyTOF)), hyperlog (Hyperlog (Gating-ML 2.0, Bagwell)), flowcore-logicle (Logicle on a 0–M axis (flowCore)), wsp-biex (Biex (FlowJo 10, channels 0–4096)), flin (Linear (Gating-ML flin)). | logicle |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| gating | No | a Gating-ML 2.0 document in the project, by name or id; empty for no gating (every statistic is then of all events). | |
| plot_x | No | channel (PnN or PnS) on the density plot's x axis; empty for no plot. | |
| plot_y | No | channel on the plot's y axis. | |
| derived | No | derived parameters, `name = expression` separated by `;` (FlowJo's vocabulary: channels by name or [name], + − * / % ^, abs ceil floor neg round max min pow exp ln log sqrt and the trig functions); each becomes a channel of the run. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cofactor | No | the c in asinh(x / c): 5 is the CyTOF convention, 150 a common one for fluorescence. Only applies when scale is arcsinh. | |
| document | No | the FCS file, by name or id; may be left empty when the project holds exactly one. | |
| stats_on | No | statistics on linear compensated values (MFI) or on the display scale. Values: linear (linear values (MFI)), scaled (display scale). | linear |
| biex_width | No | FlowJo biex width basis (negative; FlowJo's default -10). Only applies when scale is wsp-biex. | |
| compensation | No | `auto`: the file's own $SPILLOVER/$SPILL when it has one, else none; `file`: that, refusing a file without one; `none`: leave the values as acquired. Values: auto (automatic), file (file's own matrix), none (none). | auto |
| biex_negative | No | FlowJo biex extra negative decades. Only applies when scale is wsp-biex. | |
| plot_population | No | the population plotted; empty for all events. | |
| threshold_channel | No | channel to find a density-valley threshold on (flowDensity deGate on the display scale); empty for none. | |
| compensation_method | No | which published algorithm: FlowKit's solve(Sᵀ, Xᵀ) or flowCore's X · S⁻¹. They agree to ~1e-15 of full scale. Values: flowkit (solve(Sᵀ, Xᵀ) (FlowKit)), flowcore (X · S⁻¹ (flowCore)). Only applies when compensation is auto or file. | flowkit |
| threshold_population | No | the population thresholded; empty for all events. |
Output Schema
| Name | Required | Description |
|---|---|---|
| file | Yes | version, event count, every channel with its role, range, gain and decades |
| stats | Yes | per population and channel: count, mean, median, SD (n − 1), CV, min, max |
| events | Yes | events in the file |
| density | Yes | the two-channel density, events per bin, rows from the top of the plot |
| threshold | Yes | every density-valley cut on the display scale and as scale values, and how many events lie at or above |
| populations | Yes | every population: id, parent, event count, percent of parent and of all events |
| compensation | Yes | the spillover matrix used, its detectors and the algorithm, or null when the file has none |
analyze_melt_curvesCRead-onlyInspect
Melt curves to melting temperature, under any of THREE engines that answer different questions and none of which is a fallback for another.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| engine | 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 that reports peak areas. Values: plate (Plate (RDML-Python) - normalise, classify, verdicts), vertex (Vertex (MBmca diffQ) - sub-grid Tm), curve (Per curve (qpcR) - peak areas). | plate |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cut_area | 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. | |
| extremum | 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 default walks to the far end of the curve and returns a plausible-looking wrong Tm. Only applies when engine is vertex. | auto |
| resample | No | `vertex` only: resample the curve onto an even temperature grid before differentiating. Only applies when engine is vertex. Advanced. | |
| all_peaks | No | `vertex` only: report every peak the curve carries, not the dominant one alone. Only applies when engine is vertex. Advanced. | |
| melt_table | 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. | |
| span_peaks | No | `curve` only: the span Friedman's super smoother uses when the peaks are called. Only applies when engine is curve. Advanced. | |
| expected_tm | 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 the `plate` engine only, because it is the only one that classifies. In C. Only applies when engine is plate. | |
| norm_method | No | `plate` only: how each curve is normalised before it is derived. Only applies when engine is plate. Advanced. | exponential |
| peak_cutoff | No | `plate` only: the height a candidate must reach, as a percentage of the largest peak. In %. Only applies when engine is plate. Advanced. | |
| span_smooth | No | `curve` only: the smoothing span of the cubic spline fitted before the analytic derivative. Only applies when engine is curve. Advanced. | |
| fluor_source | No | `plate` only: which matrix a peak's fluorescence drop is read from — the normalised curve or the smoothed raw one. Only applies when engine is plate. Advanced. | normalised |
| expo_low_temp | 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. | |
| peak_low_temp | No | `plate` only: lowest temperature a peak is looked for at. In C. Only applies when engine is plate. Advanced. | |
| expo_high_temp | No | `plate` only: high end of the exponential fit window. In C. Only applies when norm_method is exponential or combined. Advanced. | |
| peak_high_temp | No | `plate` only: highest temperature a peak is looked for at. In C. Only applies when engine is plate. Advanced. | |
| peak_max_width | No | `plate` only: widest a peak may be before it is not read as one product. In C. Only applies when engine is plate. Advanced. | |
| window_ceiling | 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 quality that chose it. Only applies when engine is vertex. | |
| true_peak_width | 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. | |
| replicate_robust | No | replicate spread as median and MAD rather than mean and SD. Engine-independent: it describes the readings, so every run carries it. Advanced. | |
| replicate_percent | No | report replicate spread as a PERCENTAGE of the mean rather than in degrees. Advanced. | |
| second_derivative | 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. | |
| artifact_peak_width | No | `plate` only: half-width used when an extra peak is measured as an artifact. In C. Only applies when engine is plate. Advanced. | |
| bilin_low_stop_temp | No | `plate` only: end of the low seed window. In C. Only applies when norm_method is bilinear or combined. Advanced. | |
| bilin_high_stop_temp | 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. | |
| bilin_low_start_temp | 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_high_start_temp | 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 exponential-free fit and moves the result far less than the low window does. The windows actually chosen come back in the result. In C. Only applies when norm_method is bilinear or combined. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many reactions were analysed |
| engine | Yes | which engine produced these rows, named: the three answer different questions and a Tm without its engine is not comparable |
| meanTm | Yes | mean dominant Tm over the reactions that produced a peak |
| noPeak | Yes | reactions with no melting peak at all: a reaction that did not amplify, reported rather than dropped |
| targets | Yes | `plate` only: per target, the reactions that contributed a product peak and their averaged Tm against the expected one. Empty for `vertex` and `curve` |
| meltPlot | Yes | the melt curves as read from the table, one line per reaction, fluorescence against temperature. Every engine reads this same input |
| reactions | Yes | one row per reaction, in the shape the CHOSEN engine reports: `plate` gives peaks plus a verdict, `vertex` gives the sub-grid Tm with the adjusted R-squared that chose its window, `curve` gives every peak with its area |
| classified | Yes | whether the peaks were classified, and why not when they were not — including 'this engine does not classify', which is a property of the choice and not a failure |
| derivativePlot | Yes | `plate` only: −dF/dT of each reaction after normalisation and smoothing, the curve its peaks are called on, one line per reaction. Null for `vertex` and `curve`, which fit near the extremum and report no whole derivative |
| replicateSpread | Yes | location and deviation per temperature per target, from the plate's own replicates. Engine-independent: it describes the readings, not the method, so every run carries it |
annotate_regionARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| end | Yes | last base of the region, 1-based and inclusive. | |
| build | 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. | |
| start | Yes | first base of the region, 1-based. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| dosage | 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 evidence, and the count of them is reported instead. Values: any (Either direction), loss (Loss), gain (Gain). | any |
| tracks | No | which tracks to read, comma-separated: `genes`, `dgv`, `segdups`. Unset reads all three. The coding verdict comes with `genes`. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| chromosome | Yes | UCSC-style sequence name; a bare `17` or `X` is read as `chr17`/`chrX`. |
Output Schema
| Name | Required | Description |
|---|---|---|
| dgv | Yes | DGV records of comparable dosage with study, sample size, frequency and reciprocal overlap; the fraction of the region they cover; how many balanced or unclassified records were not counted; the track provenance |
| genes | Yes | overlapping gene symbols, the ones with coding sequence in the region, and every transcript with the exons it touches; carries the track provenance |
| coding | Yes | the coding verdict (none, noncoding, partial, whole), the complete CDSs the region contains, the partial ones with how much of each it holds, and the reason a residue-level action is refused when it is |
| segdups | Yes | segmental duplications overlapping the region with their partner locus and identity, the fraction of the region they cover, and the track provenance |
| summary | Yes | what each track answered for this region, generated from the run |
antibody_antigen_contactsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| text | 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 | No | which model of an ensemble to type, 1-based: conformers touch in different places, so one is typed rather than all. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| antibodyChain | No | type only this chain against the antigen. Left out, every chain carrying a variable domain is typed. | |
| antigenChains | No | comma-separated chain ids to treat as the antigen. Left out, every protein chain with no variable domain is the antigen. | |
| interactingCutoff | No | atom pairs further apart than this (Å) are not reported at all; Arpeggio's own default is 5. |
Output Schema
| Name | Required | Description |
|---|---|---|
| byType | Yes | atom pairs carrying each type over the whole interface, distance bands included |
| contacts | Yes | one row per residue pair: the antibody residue (chain, author number, name, and its scheme position where it sits in a variable domain), the antigen residue, the closest atom distance, the atom-pair count, and the interaction types |
| residues | Yes | how many residues each side contributes, per antibody chain |
| antigenChains | Yes | the chain ids treated as the antigen |
| antibodyChains | Yes | the chains typed, each with its variable-domain chain types |
antibody_canonical_classesARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| scheme | No | the numbering the clusters are read in. Values: imgt (IMGT), chothia (Chothia). | imgt |
| protein | Yes | the protein sequence (one-letter amino acids); every heavy, kappa and lambda variable domain in it is classified. | |
| species | No | species whose HMMs are preferred when numbering (ANARCI's default: human and mouse). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| definition | No | where each CDR begins and ends, by SCALOP's own tables. Values: imgt (IMGT), chothia (Chothia), north (North). | north |
Output Schema
| Name | Required | Description |
|---|---|---|
| classes | Yes | one `CDR: class` string per CDR, in sequence order (`H1: H1-13-A`, `None` where no class fits) |
| domains | Yes | per heavy, kappa or lambda domain: chain type, span, and per CDR the loop sequence, its class (cluster id), the median structure, the cluster's size, the outcome, SCALOP's threshold, every candidate cluster's score, and each residue's position, 0-based sequence index and log-odds in the assigned cluster |
antibody_isotypeBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| protein | Yes | the chain (one-letter amino acids); the constant region in it is found, so a whole heavy chain is fine. | |
| species | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| minIdentity | No | a domain matching less of its reference than this is not reported. |
Output Schema
| Name | Required | Description |
|---|---|---|
| gene | Yes | the IMGT gene the constant region matches (IGHG1) |
| allele | Yes | the allele, as IMGT numbers them (01) |
| domains | Yes | each IMGT label placed on the chain: label, start, end (1-based inclusive), identity, coverage |
| species | Yes | the species whose gene answered |
| identity | Yes | identical residues over every aligned column, 0 to 1 |
antibody_liabilitiesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| rules | No | which liabilities to report (default: all). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| cdrOnly | No | report only liabilities that start inside a CDR. | |
| protein | Yes | the protein sequence (one-letter amino acids). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | number of liabilities reported |
| cdrCount | Yes | number of reported liabilities inside a CDR |
| liabilities | Yes | each hit: rule, motif, 0-based start and end, IMGT positions, region, whether in a CDR, source |
antibody_moleculeARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| pH | No | the pH the net charge is reported at. | |
| heavy | Yes | the heavy chain (one-letter amino acids), as much of it as the molecule carries. | |
| light | Yes | the light chain (kappa or lambda, one-letter amino acids). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| format | No | how many copies of each chain the molecule holds. Values: fab (Fab (1 heavy + 1 light)), igg (IgG (2 heavy + 2 light)). | igg |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| absorbance | Yes | A280 of a 1 g/L solution, `reduced` and `cystines` |
| chargeAtPH | Yes | net charge at the requested pH |
| extinction | Yes | ε280 in M⁻¹ cm⁻¹, `reduced` and `cystines` |
| molecularWeight | Yes | average mass of the whole molecule, Da (chains reduced) |
| isoelectricPoint | Yes | isoelectric point of the whole molecule (Bjellqvist pKs, each chain with its own termini) |
antibody_position_frequenciesBRead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| protein | Yes | the protein sequence (one-letter amino acids); every antibody and T-cell-receptor variable domain in it is read. | |
| species | No | species whose HMMs are preferred when numbering (ANARCI's default: human and mouse). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| rare_below | 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). | |
| distribution | 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 |
| germline_species | No | the species whose IMGT germline alleles each position is counted over (germline distribution only; the repertoire is human). | human |
Output Schema
| Name | Required | Description |
|---|---|---|
| rare | Yes | one `IMGT position residue (count of n)` string per rare residue, in sequence order |
| domains | Yes | per domain: chain type, span, what the table counted (germline allele counts, or the repertoire's sequence count and subset), and per residue its IMGT position, 0-based sequence index, count, denominator, frequency, the commonest residue there and whether it is rare |
apply_feature_fileBInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | 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 intervals is the mistake this parameter exists to prevent. | |
| coordinates_only | 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 own data, and the run records it as the basis it used. Required whenever either side is silent about its assembly; it cannot rescue two assemblies that disagree. |
Output Schema
| Name | Required | Description |
|---|---|---|
| added | Yes | how many features were written — branch on this rather than counting |
| basis | Yes | what earned the apply: 'matched' when both assemblies agreed, 'coordinate-space-only' when you stated it. A run's provenance, not a status |
| record | Yes | the open record with the applied features added |
| duplicate | Yes | how many were already on the record at the same span, strand and type, so they were not written twice |
| outOfRange | Yes | the features whose spans run past the end of the record, each with the end it really has. Reported, never trimmed: a span cut to fit is a different feature |
apply_variant_callBRead-onlyInspect
Substitute one called ALT allele into a sequence and return the edited bases, the range the edit occupies and the length change.
| Name | Required | Description | Default |
|---|---|---|---|
| pos | Yes | the POS of the record to apply, 1-based as VCF writes it. | |
| file | No | which call set the variant comes from, by name. Unset, it is the project's only one. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| contig | Yes | the contig of the record to apply, as the file names it. | |
| offset | 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 from, which is what lets a genomic call be applied to it at all. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | Yes | the sequence to edit. | |
| alt_index | No | which ALT of a multiallelic record to apply, counting from 1 as the file lists them. Default the first. |
Output Schema
| Name | Required | Description |
|---|---|---|
| delta | Yes | signed length change, which is what any annotation downstream of the edit must shift by |
| applied | Yes | the record as applied: chrom, pos, ref, the ALT chosen and its index, so a run record says which allele of a multiallelic site was taken |
| summary | Yes | the edit in one sentence, generated from this run |
| sequence | Yes | the sequence with this ALT substituted for the REF, ready to wire into a next step. Every base outside the edited range is unchanged, and the length differs from the input by `delta`, so any coordinate downstream of `edited_start` has moved by that much |
| edited_end | Yes | 0-based INCLUSIVE end of the edited range in the new sequence. Inclusive, not half-open, because it is the end of a selection a reader is meant to see highlighted rather than a slice bound |
| edited_start | Yes | 0-based inclusive start of the range the edit occupies in the NEW sequence, for selecting it |
assemble_index_oligosARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| format | No | adapter arms around the index, or a tagged PCR primer. Values: adapter (5'/3' adapter arms), primer (Tagged PCR primer). | adapter |
| primer | No | the PCR primer the tag is appended to — required when `format` is `primer`. | |
| spacer | No | bases between the tag and the primer. Heterogeneity/phasing spacers are routine on a low-diversity library. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| barcodes | Yes | the index sequences to assemble. | |
| adapter_3 | No | 3' arm the index is spliced before — the TruSeq read-1 primer, and the panel's own default. | ACACTCTTTCCCTACACGACGCTCTTCCGATCT |
| adapter_5 | No | 5' arm the index is spliced after — the Illumina P5, and the panel's own default. | AATGATACGGCGACCACCGAGATCTACAC |
| reverse_complement_tag | No | use each tag as its reverse complement, in an adapter or on a primer, as the instrument requires for some read orientations. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many oligos were assembled |
| oligos | Yes | each assembled oligo with its name, sequence and length |
| longest | Yes | the longest assembled oligo, in bases — the number a synthesis quote turns on |
| warnings | Yes | junction problems that only exist once tag and oligo are joined: a run across the junction, a self-complementary 5' tetramer, an oligo over the synthesis guideline |
assemble_multiple_insertsBInspect
Open ONE circular backbone at several places and place several inserts in a single step.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | 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 refused by name rather than ignored. | |
| inserts | Yes | the fragments to place, one per insertion point — wire upstream `record` outputs here, or name library documents. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| backbone | No | the circular vector to open. Leave unset to use the open record. | |
| max_constructs | No | cap on how many distinct constructs are enumerated. Advanced. | |
| max_homology_bp | No | longest terminal homology considered; the bound is EXCLUSIVE, as upstream's own range is. In bp. | |
| min_homology_bp | No | minimum terminal homology for two ends to join. In bp. |
Output Schema
| Name | Required | Description |
|---|---|---|
| arcs | Yes | the backbone's arcs: their lengths and the enzyme that made each end — the insertion points, made readable |
| record | Yes | the first construct, as a record |
| reading | Yes | what was planned, generated from the enumeration rather than the request |
| cutCounts | Yes | sites found per enzyme, so an enzyme that does not cut is named rather than silently absent |
| placements | Yes | every construct the ring closes on, each with the inserts in the order they sit around it |
| insertionPoints | Yes | how many gaps the digest left, which is how many inserts the step takes |
assemble_operonAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| cds | Yes | the coding sequences to stack, in order — wire upstream `record` outputs here, or name library documents. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| leader | No | leader placed before the FIRST ribosome-binding site (defaults to the design leader). Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| promoter | No | promoter sequence to place in front of the operon (optional). Advanced. | |
| terminator | No | terminator sequence to place after the last gene (optional). Advanced. | |
| include_subject | No | put the node's subject first, as the first gene. | |
| target_strength | 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 | 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 the rest. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| genes | Yes | per gene: the RBS designed for it, its spacing, the strength achieved and whether it hit the target |
| layout | Yes | every element in order — promoter, each RBS, each CDS, terminator — with its start and end |
| record | Yes | the assembled operon as a record |
| onTarget | Yes | true when EVERY gene reached its target strength — the number to check before ordering |
| sequence | Yes | the assembled operon sequence |
assembly_plan_simulateCInspect
Run a MULTI-LEVEL assembly plan (DnaCauldron AssemblyPlan): several assemblies arranged into dependency levels, where each level's products become parts for the next.
| Name | Required | Description | Default |
|---|---|---|---|
| plan | 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. | |
| parts | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| method | 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 (linker-based)), lcr (Ligase cycling reaction), annealing (Oligo pair annealing). | biobrick |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| include_subject | No | also offer the node's subject as a part. |
Output Schema
| Name | Required | Description |
|---|---|---|
| built | Yes | steps that produced a construct |
| failed | Yes | steps that errored |
| levels | Yes | the derived build order: which steps happen at which level |
| record | Yes | the final construct (deepest level), as a record |
| cancelled | Yes | steps never attempted because a dependency failed |
| leafParts | Yes | the physical parts a bench user must actually have |
| constructs | Yes | every construct produced, in build order |
assess_small_moleculeCRead-onlyInspect
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 formula with its masses and natural-abundance isotope pattern, QED drug-likeness under all three weightings, ESOL aqueous solubility, synthetic accessibility and natural-product likeness, the Bemis–Murcko scaffold and generic framework, the BOILED-Egg's gut-absorption and brain-penetration verdicts, and per-atom logP, polar-surface and charge contributions.
| Name | Required | Description | Default |
|---|---|---|---|
| rules | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| molecule | Yes | the structure: a SMILES string or an MDL molfile (V2000 or V3000). One molecule; for an SDF, pass one record. | |
| alert_sets | No | which structural-alert catalogs to screen against. Empty screens nothing, which is not a clean result. |
Output Schema
| Name | Required | Description |
|---|---|---|
| qed | Yes | QED (Bickerton 2012) with mean weights, maximum weights and unweighted; the eight inputs (MW average mass, ALOGP Crippen, HBA, HBD, PSA, ROTB, AROM, ALERTS) and each input's desirability; and the SMARTS of every unwanted group QED counted |
| rules | Yes | one entry per rule evaluated: id, label, passes, citation, and every clause with its property, bound and this molecule’s value. A rule with anyClauses passes when at least one of those holds |
| alerts | Yes | every alert matched: its set, name, SMARTS and the atom indices of the first match, numbered on the implicit-hydrogen molecule |
| formula | Yes | RDKit's molecular formula (every hydrogen, isotope labels merged, charge suffixed) with its element counts and charge, the monoisotopic and average masses in Da, and OpenMS's coarse natural-abundance isotope envelope (isotope index, mass, share of molecules), or the reason there is none (an isotope-labeled structure, or an element OpenMS has no isotope data for) |
| summary | Yes | the assessment in one sentence, generated from this run |
| scaffold | Yes | the Bemis–Murcko scaffold (ring systems and linkers, side chains removed) as canonical SMILES, empty for a molecule with no ring; the generic framework (every atom carbon, every bond single), null where an atom has more bonds than carbon allows; and the indices of the atoms the scaffold keeps, on the implicit-hydrogen molecule |
| structure | Yes | the 2D structure every reading was taken on, drawn by RDKit with implicit hydrogens as the chemistry tab opens it |
| boiled_egg | Yes | the BOILED-Egg placement (Daina & Zoete 2016) of the neutral, unsalted ChEMBL parent as the paper places it (`placed` says whether that is the parent or, when the pipeline refuses one or it is the molecule itself, the record as drawn; `asDrawn` and `parent` carry both): tPSA counting S and P, RDKit's Crippen logP standing in for WLOGP, and for the gut-absorption (hia) and brain-penetration (bbb) ellipses whether the point is inside, its summed focal distance and the ellipse's major axis; region is yolk, white or outside |
| solubility | Yes | ESOL (Delaney 2004) log S in mol/L under two coefficient sets, rdkitRefit (Walters' refit to RDKit descriptors) and delaney2004 (the paper's, with Crippen logP for Daylight CLOGP), and the four inputs: Crippen logP, average mass, rotatable bonds, aromatic proportion |
| descriptors | Yes | RDKit's descriptors under RDKit's own keys (exactmw, CrippenClogP, tpsa, NumHBD …) |
| np_likeness | Yes | Ertl et al. 2008 natural-product likeness, about -5 (synthetic-like) to 5 (natural-product-like), and the confidence: the share of the molecule's fragments the model knows |
| canonical_smiles | Yes | RDKit's canonical SMILES of the molecule every reading was taken on |
| atom_contributions | Yes | per-atom weights on the implicit-hydrogen molecule: logp (Crippen, heavy atoms), tpsa (Ertl, N and O), tpsaSP (Ertl with S and P) and charge (Gasteiger–Marsili; not a number around an element RDKit has no parameters for) |
| bioavailability_radar | Yes | SwissADME's Bioavailability Radar (Daina 2017): six axes (lipo, size, polar, insolu, insatu, flex) with this molecule's value, the inclusive window, whether it is inside, and drugLike when all six are; read with Crippen logP for XLOGP3 and the XLOGP3 window's figure bound of 5.0 |
| synthetic_accessibility | Yes | Ertl & Schuffenhauer 2009 synthetic accessibility, 1 (easy) to 10 (hard), with its fragment score, complexity penalty, symmetry correction, the counts they read and how many fragments the table did not know; null only if the fragment table could not be loaded |
audit_barcodesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| metric | 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). | seqlev |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| barcodes | Yes | the index sequences to audit. | |
| prune_to_errors | No | also report the subset that would survive pruning to a free code correcting this many errors. 0 = do not prune. Advanced. | |
| required_distance | No | the minimum distance the set is supposed to have — the audit says whether it does. |
Output Schema
| Name | Required | Description |
|---|---|---|
| kept | Yes | the barcodes surviving `prune_to_errors` (the whole set when pruning is off) |
| audit | Yes | the verdict: the set's real minimum distance, what it guarantees, and every pair that falls short |
| dropped | Yes | how many the prune removed |
| analysis | Yes | per-metric analysis of the whole set |
| matrices | Yes | the pairwise distance matrix under each metric |
| statistics | Yes | the whole-set statistics the four charts above are drawn from, which a min-distance figure hides: GC mean, spread and range, Shannon entropy per cycle, the fraction reading each base at each cycle, groups sharing a prefix in the first cycles read, duplicates, and the per-metric distance distributions |
| distanceMap | Yes | the pairwise distance matrix under the chosen metric, as a heatmap |
| gcHistogram | Yes | how many barcodes sit at each GC percentage |
| baseComposition | Yes | the fraction of the set reading each base at each cycle |
| distanceHistogram | Yes | how many PAIRS sit at each distance under the chosen metric: the shape behind the minimum |
| neighbourHistogram | Yes | how many BARCODES have each nearest-neighbour distance: where the weak links are |
audit_cds_annotationsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| genbank | Yes | the GenBank files' contents, one string per file (a file may hold several records). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| flags | Yes | per flag, how many CDS carry it and in how many records |
| result | Yes | the full result |
| flagged | Yes | every CDS with a flag: record, feature, label, location and the flags |
| readThrough | Yes | every annotation that ends without a stop, with where reading on stops |
auto_annotateBInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | 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 other found. | both |
| lox_p | No | detect Cre/loxP-family recognition sites. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| policy | 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` drops every existing feature first. | merge |
| gateway | No | detect Gateway att recombination sites. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| libraries | 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 it leaves off for their size, AMRFinderPlus and Rfam; name those to search them too. | |
| max_expect | 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. | |
| alternatives | 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 | No | protein corpora only: the NCBI translation table the six frames are read under. 1 is the standard code. Advanced. | |
| min_coverage | No | protein corpora only: drop a translated call covering less than this much of the database protein's own length. Advanced. | |
| min_identity | No | protein corpora only: drop a translated call under this percent identity over the residues aligned. Advanced. | |
| accepted_only | 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 cannot displace one it would accept. Only applies when mode is alignment or both. Advanced. | |
| greedy_gateway | No | permissive att core matching — finds more sites, including partial ones. Only applies when gateway is true. Advanced. | |
| hide_fragments | No | hide hits covering under 95% of their database entry, which upstream calls fragments. Only applies when mode is alignment or both. Advanced. | |
| min_pi_per_match | 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 both. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| record | Yes | the subject with the found features added |
| features | Yes | every feature found, with its source detector |
| perSource | Yes | hit count per detector |
| featureCount | Yes | how many features were found |
auto_gate_flow_cytometryBRead-onlyInspect
openCyto 2.24's automated gates on two channels of an FCS file: a cut on each axis (gate_mindensity, the minimum of the KDE between its two highest peaks; gate_mindensity2, features of a smoothing spline over the KDE; or gate_quantile), the sequential quadrant gate (gate_quad_sequential), and the singlet gate on area × height (gate_singlet, a Huber regression and its prediction band).
| Name | Required | Description | Default |
|---|---|---|---|
| A | No | additional negative decades. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| M | No | decades of the full scale. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| T | No | top of scale; empty means the file's largest fluorescence $PnR. | |
| W | No | linear width in decades. Only applies when scale is logicle or hyperlog or flowcore-logicle. | |
| cut | No | the one-dimensional gate placed on each axis. Values: none (none), mindensity (minimum density), mindensity2 (spline features), quantile (quantile). | mindensity |
| quad | No | also fit the sequential quadrant gate. | |
| seed | No | R set.seed for the subsample. | |
| probs | No | quantile: the quantile the cut sits at. | |
| scale | No | the display scale of the fluorescence channels (scatter and time stay linear): used for the plot, the threshold and, with `stats_on: scaled`, the statistics. Values: logicle (Logicle (Gating-ML 2.0, Moore & Parks)), fasinh (ArcSinh (Gating-ML 2.0 fasinh)), arcsinh (ArcSinh with a cofactor (asinh(x / c), Cytobank and CyTOF)), hyperlog (Hyperlog (Gating-ML 2.0, Bagwell)), flowcore-logicle (Logicle on a 0–M axis (flowCore)), wsp-biex (Biex (FlowJo 10, channels 0–4096)), flin (Linear (Gating-ML flin)). | logicle |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| adjust | No | KDE bandwidth multiplier (openCyto's adjust). | |
| gating | No | a Gating-ML 2.0 document in the project, by name or id; empty for no gating (every statistic is then of all events). | |
| plot_x | No | channel (PnN or PnS) on the density plot's x axis; empty for no plot. | |
| plot_y | No | channel on the plot's y axis. | |
| derived | No | derived parameters, `name = expression` separated by `;` (FlowJo's vocabulary: channels by name or [name], + − * / % ^, abs ceil floor neg round max min pow exp ln log sqrt and the trig functions); each becomes a channel of the run. | |
| singlet | No | also fit the singlet gate. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cofactor | No | the c in asinh(x / c): 5 is the CyTOF convention, 150 a common one for fluorescence. Only applies when scale is arcsinh. | |
| document | No | the FCS file, by name or id; may be left empty when the project holds exactly one. | |
| positive | No | mindensity: keep the side above the cut. | |
| biex_width | No | FlowJo biex width basis (negative; FlowJo's default -10). Only applies when scale is wsp-biex. | |
| wider_gate | No | weight the band's ends by the extreme events' Huber weights. | |
| compensation | No | `auto`: the file's own $SPILLOVER/$SPILL when it has one, else none; `file`: that, refusing a file without one; `none`: leave the values as acquired. Values: auto (automatic), file (file's own matrix), none (none). | auto |
| singlet_area | No | area channel of the singlet gate; empty for FSC-A. | |
| biex_negative | No | FlowJo biex extra negative decades. Only applies when scale is wsp-biex. | |
| subsample_pct | No | fit the singlet gate on this fraction of events; empty for every event. | |
| singlet_height | No | height channel of the singlet gate; empty for FSC-H. | |
| plot_population | No | the population plotted; empty for all events. | |
| prediction_level | No | the prediction band level of the singlet polygon. | |
| compensation_method | No | which published algorithm: FlowKit's solve(Sᵀ, Xᵀ) or flowCore's X · S⁻¹. They agree to ~1e-15 of full scale. Values: flowkit (solve(Sᵀ, Xᵀ) (FlowKit)), flowcore (X · S⁻¹ (flowCore)). Only applies when compensation is auto or file. | flowkit |
Output Schema
| Name | Required | Description |
|---|---|---|
| cuts | Yes | per axis: the cut, events at or above and at or below it, the rule that chose it, the KDE peaks and valleys |
| singlet | Yes | the singlet polygon in (area, height), its coefficients, residual scale, seed and events inside |
| quadrants | Yes | the three cuts, which axis was cut first, and events per quadrant |
back_translateBRead-onlyInspect
Protein → DNA: the coding sequence that would encode a protein, weighted by a real codon-usage table.
| Name | Required | Description | Default |
|---|---|---|---|
| host | 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 session are valid names as well as the bundled ones. Only applies when strategy is mostFrequent or weightedRandom. | E. coli K-12 |
| seed | 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. | |
| table | No | genetic code the codons are chosen under. | Standard |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| protein | Yes | the protein sequence, one-letter codes (B/Z/J/U/O/X and gaps are handled and reported); wire it from translate_sequence. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| strategy | 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 distribution: a natural-looking gene rather than a run of one codon. | ambiguous — EMBOSS backtranambig: one ambiguity-coded codon covering EVERY codon for the residue. The degenerate-primer answer; needs no usage table. | firstCodon — DnaChisel's reverse_translate. Deterministic and table-free, but it is not a biological preference: use it only to reproduce a DnaChisel result. | mostFrequent |
| append_stop | No | append a stop codon, chosen by the same strategy and table as every other codon. Skipped when the residues already end in *. |
Output Schema
| Name | Required | Description |
|---|---|---|
| gc | Yes | GC fraction of the product (0–1), over unambiguous bases only |
| dna | Yes | the coding sequence — wire it into optimize_sequence, or open it as a record |
| cautions | Yes | only the caveats THIS product earned, each with its measurement and whose published limit it crossed — an empty list is the healthy case and is not padded |
| residues | Yes | every residue with the codon chosen, its share of its synonymous family, and why if it took a special path |
| conclusion | Yes | one generated sentence saying what this product IS — size, GC, and how adapted it is to the table you named. Built from the run by the same `conclusionOf` the panel headlines, so a turn and the panel cannot state different things about one design |
| provenance | Yes | the assumptions the answer rests on: strategy, genetic code, codon-usage table and residue count — the same facts the panel prints under the product |
| undefinedResidues | Yes | residues the genetic code has no codon for; each became NNN |
| unweightedResidues | Yes | residues whose synonymous family carried NO weight in this table, so codon order decided the answer rather than usage — empty is the healthy case |
bayesian_protein_inferenceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| beta | No | spurious emission probability β: the chance a peptide is reported with none of its proteins present. | |
| psms | 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. | |
| alpha | No | peptide emission probability α: the chance a present protein yields a given one of its peptides. | |
| gamma | No | protein prior γ: the chance a protein is present before any evidence. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| database | Yes | the protein database searched, as FASTA; the accession is the header up to the first space. | |
| psmCutoff | No | drop matches whose probability (1 − PEP) is below this. | |
| gridSearch | 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; needs decoy proteins. | |
| decoyPrefix | No | accession prefix marking a decoy protein, for the grid search. | DECOY_ |
| scoreColumn | No | the column holding each match's posterior error probability (PEP, 0 to 1). | pep |
| ilEquivalent | No | treat isoleucine and leucine (and a database J) as the same residue when mapping peptides. | |
| peptidePrior | No | peptide prior π, dividing each match's probability back out of its evidence. | |
| appendReversedDecoys | 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 | No | how many ambiguous database residues (B, J, Z, X) one peptide match may resolve. |
Output Schema
| Name | Required | Description |
|---|---|---|
| grid | Yes | with the grid search: every α, β, γ tried, with its FDR-curve difference, ROC-100 and objective (skipped when improbable) |
| count | Yes | proteins reported |
| groups | Yes | indistinguishable protein groups, most probable first: probability that at least one member is present, and accessions |
| proteins | Yes | one row per protein: accession, posterior probability, matches counted, sequence coverage (%) |
| psmPosteriors | Yes | the matches inference used (the best per peptide): spectrum, peptide, prior (1 − PEP) and posterior |
blast_project_sequencesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| region | 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). | whole |
| feature | No | the feature's name, matched case-insensitively on the open record. Only applies when region is feature. | |
| program | No | blastn searches the nucleotide records, blastp the protein records. Values: blastn (blastn · nucleotide query), blastp (blastp · protein query). | blastn |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | 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. | |
| maxExpect | No | E-value cutoff (BLAST+'s -evalue); hits above it are not reported. |
Output Schema
| Name | Required | Description |
|---|---|---|
| hits | Yes | every hit, with its HSPs, accession, organism and the links the service sent |
| topHit | Yes | the best hit by E-value: what a "what is this?" step reads |
| tabular | Yes | the hits as BLAST's own outfmt 6 table, for download or a downstream parser |
| hitCount | Yes | how many subjects matched |
| sequences | Yes | the hit subjects as FASTA, ready to wire straight into an alignment or a tree |
| topExpect | Yes | the best hit's E-value; wire into a $when to branch on significance |
| provenance | Yes | the binary, the command line EBI ran, the databases as built, and the search space the E-values are relative to |
| topCoverage | Yes | what fraction of the query the best hit covers, 0–1 |
| topIdentity | Yes | percent identity of the best hit's best HSP |
blast_searchBRead-onlyInspect
Search a sequence against NCBI BLAST+ at EMBL-EBI (blastn, blastp, blastx, tblastn or tblastx) over ENA, UniProtKB, PDB and the vector-screening sets.
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | ||
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| region | 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). | whole |
| feature | No | the feature's name, matched case-insensitively on the open record. Only applies when region is feature. | |
| program | 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 · protein query), blastx (blastx · dna query), tblastn (tblastn · protein query), tblastx (tblastx · dna query). | blastn |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | 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. | |
| databases | 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 back. | |
| parameters | 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's default for this context. An id the service does not advertise is refused by name rather than dropped. |
Output Schema
| Name | Required | Description |
|---|---|---|
| hits | Yes | every hit, with its HSPs, accession, organism and the links the service sent |
| jobId | Yes | the dispatcher job id: what a methods section cites and what re-fetches this exact result |
| topHit | Yes | the best hit by E-value: what a "what is this?" step reads |
| tabular | Yes | the hits as BLAST's own outfmt 6 table, for download or a downstream parser |
| hitCount | Yes | how many subjects matched |
| sequences | Yes | the hit subjects as FASTA, ready to wire straight into an alignment or a tree |
| topExpect | Yes | the best hit's E-value; wire into a $when to branch on significance |
| provenance | Yes | the binary, the command line EBI ran, the databases as built, and the search space the E-values are relative to |
| topCoverage | Yes | what fraction of the query the best hit covers, 0–1 |
| topIdentity | Yes | percent identity of the best hit's best HSP |
bootstrap_cqARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| drop | 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 jack. | |
| seed | No | R's `set.seed` value, so the interval is reproducible and citable. Advanced. | |
| model | 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 nothing. Values: l4 (l4 · 4-param log-logistic), l5 (l5 · + asymmetry), l6 (l6 · + linear baseline drift), l7 (l7 · + quadratic baseline), b4 (b4 · 4-param logistic (raw scale)), b5 (b5 · + asymmetry), b6 (b6 · + linear baseline drift), b7 (b7 · + quadratic baseline). | l4 |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| curves | 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. | |
| scheme | 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 cycle carry it?". | boot |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| reaction | 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 nobody asked for. | |
| cq_method | 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 · exponential region), Cy0 (Cy0 · tangent x-intercept (Guescini)), CQ (CQ · 20 % of the Cq fluorescence), maxRatio (maxRatio · spline, model-free (Shain)). | cpD2 |
| conf_level | No | the level the reported bounds are read at — 0.95 puts them at the 2.5 % and 97.5 % quantiles of the iterations. | |
| iterations | 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. | |
| include_readouts | 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 and returns coefficients alone. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rss | Yes | residual sum of squares across the iterations |
| rmse | Yes | residual standard error across the iterations |
| model | Yes | the model refitted on every iteration |
| reaction | Yes | the reaction actually resampled, named — "the first column" is not a citation |
| readouts | Yes | one row per resampled readout — Cq under each definition, efficiency, initial fluorescence — with mean, SD, median and the interval quantiles. Empty when `include_readouts` is off |
| confLevel | Yes | the level the bounds above are read at |
| converged | Yes | iterations whose refit converged — the ONLY ones any number here is computed from. Well below `iterations` is a finding about the curve, not a warning to swallow |
| iterations | Yes | iterations requested |
| coefficients | Yes | one row per model coefficient, in the model's own parameter order, same fields |
browse_regionARead-onlyInspect
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 strand, cut position and on-target scores.
| Name | Required | Description | Default |
|---|---|---|---|
| gene | No | a gene symbol; the window is its MANE Select (or HGNC) transcript with a 2% margin either side. Takes precedence over `locus`. | |
| locus | No | the window, 1-based and inclusive, when no `gene` is given. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| assembly | Yes | the UCSC assembly name (hg38, hg19, mm39…). | |
| nuclease | 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 · NG), SpG (SpG · NGN), SpRY (SpRY · NRN), xCas9 (xCas9 · NG), SaCas9 (SaCas9 · NNGRRT), SaCas9-KKH (SaCas9-KKH · NNNRRT), AsCas12a (AsCas12a · TTTV), LbCas12a (LbCas12a · TTTV), enAsCas12a (enAsCas12a · TTTV). | SpCas9 |
| gene_track | No | which RefSeq set the transcripts and protein residues come from. Values: ncbiRefSeqSelect (RefSeq Select and MANE), ncbiRefSeqCurated (RefSeq Curated), ncbiRefSeq (RefSeq All), ncbiRefSeqPredicted (RefSeq Predicted). | ncbiRefSeqSelect |
Output Schema
| Name | Required | Description |
|---|---|---|
| sites | Yes | CRISPR sites: spacer, PAM, strand, 1-based protospacer bounds, cut position and Rule Set 1 / CRISPRscan scores |
| window | Yes | the window read, 1-based inclusive, and how it was reached |
| protein | Yes | per transcript: accession, strand, the first and last residue numbers in the window and the residues themselves |
| summary | Yes | what each lane found in the window, generated from the run |
| refusals | Yes | each lane that did not run for this window, and why |
build_addgene_depositARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| answers | 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 once without answers to read them from `columns`. | |
| genbank | Yes | the plasmids to deposit, as GenBank text: one row per nucleotide record. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| file | Yes | the filled workbook: `name`, and its bytes as `base64` |
| columns | Yes | every column of Addgene's sheet: its header, Addgene's help text, and its choices where it has a drop-down |
| reading | Yes | what was written and what is left for the depositor, generated from the run |
| written | Yes | plasmids written into the sheet |
| problems | Yes | every value left out because the sheet would refuse it, with the plasmid, the column and the reason |
build_assembly_reportARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzyme | No | the Type-IIS enzyme, 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, which has no enzyme: an empty column would imply one exists. | |
| errors | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| products | No | the enumerated constructs — wire an assembly node's `products` output. Each needs `id`, `sequence` and `fragmentNames`, which is what both assembly nodes emit. | |
| warnings | No | structured assembly warnings — wire the assembly node's `warnings` output. | |
| assembly_name | No | the name for this assembly: the `assembly_name` column of the summary table and the first field of every errors row. | assembly |
Output Schema
| Name | Required | Description |
|---|---|---|
| stats | Yes | the Outcome / Number of assemblies table, as `compute_stats` produces it |
| report | Yes | the whole report object, including the summary dataframe and the plots decision |
| errorsCsv | Yes | the errors spreadsheet — upstream's `errors.csv`, or an empty string when the run had none. Faithful to upstream's own 4-header / 3-field mismatch |
| partsUsed | Yes | every part name that appears in at least one construct |
| summaryCsv | Yes | the constructs spreadsheet, pandas-compatible CRLF CSV — upstream's `constructs.csv` |
| summaryText | Yes | the report as plain text, for a run record or a note |
| warningsCsv | Yes | the warnings spreadsheet, or an empty string when the run had none |
| constructCount | Yes | how many constructs the summary table describes |
build_ena_submissionARead-onlyInspect
Turn a record into what ENA's Webin-CLI takes for an annotated sequence (-context sequence): an ENA flat file (.embl) and its manifest.
| Name | Required | Description | Default |
|---|---|---|---|
| study | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| genbank | Yes | the record to submit, as GenBank text. Its features, topology and DEFINITION are read from it. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| mol_type | No | the source feature's mandatory /mol_type. `other DNA` is the INSDC value for a synthetic construct. | other DNA |
| organism | No | the scientific name of the source organism; ENA checks it against its taxonomy. `synthetic construct` is a real answer for a built vector. | synthetic construct |
| topology | 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). Advanced. | |
| description | No | the DE line, what the sequence is. Left empty, each record's own DEFINITION is used; ENA refuses one shorter than 10 characters. | |
| geo_loc_name | No | where the sample came from, from the INSDC vocabulary, or a missing-value term. | missing: lab stock |
| collection_date | 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`. | missing: lab stock |
Output Schema
| Name | Required | Description |
|---|---|---|
| files | Yes | the flat file and its manifest, each with its `name` and `text`. Gzip the flat file before running Webin-CLI; the manifest already names the `.gz` |
| changes | Yes | every feature the writer refused, rewrote or left a qualifier off, each with ENA's reason |
| command | Yes | the exact gzip and webin-cli invocation, with -validate |
| reading | Yes | what the set is, generated from what was written |
| written | Yes | features written, source excluded |
| flatFile | Yes | the `.embl` alone, for reading or diffing |
| problems | Yes | why Webin-CLI will refuse the set as it stands: a short description, a short entry, no study, or a malformed date or locality. Empty means none of those, never that the validator will be silent |
build_genbank_submissionARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| genbank | Yes | the record to submit, as GenBank text. Its features and topology are read from it — wire it from an export, or paste it. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| mol_type | 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. | genomic DNA |
| organism | No | the scientific name of the source organism. `synthetic construct` is a real answer for a built vector, not an absence. | synthetic construct |
| topology | 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 used. Values: (From the record), circular (Circular), linear (Linear). Advanced. | |
| geo_loc_name | 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. | missing: lab stock |
| collection_date | 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 was never collected anywhere takes an INSDC missing-value term such as `missing: lab stock`. | missing: lab stock |
Output Schema
| Name | Required | Description |
|---|---|---|
| files | Yes | the submission set: one entry per file, each with its `name` and `text`. The two names share a basename, which is how table2asn pairs them |
| changes | Yes | every feature the writer migrated, relabelled, refused or stripped a qualifier from, each with the authority's reason. Never empty-because-nothing-was-checked |
| command | Yes | the exact table2asn invocation for the set, naming the submission template the user must make first |
| reading | Yes | what the set is, generated from the record that was written rather than from the request |
| written | Yes | features written into the table. Branch on this rather than counting `changes` |
| problems | Yes | why the set cannot be submitted as it stands — an illegal collection date or a locality outside the vocabulary. Empty means the two mandatory modifiers are good, never that NCBI will be silent |
| featureTable | Yes | the `.tbl` alone, for pasting or diffing |
build_treeARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| gamma | No | gamma shape for among-site rate variation in the DISTANCE correction; 0 disables. Not the ML +Γ, which is `ml_gamma_categories`. Advanced. | |
| model | No | distance/substitution model (ape's names). K80 is the engine's default; very divergent sequences need raw or JC69. | K80 |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| method | 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 (UPGMA), wpgma (WPGMA), parsimony (Maximum Parsimony), ml (Maximum Likelihood), bayesian (Bayesian (MCMC)). | nj |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| ml_model | 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. | GTR |
| ml_shape | 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_gamma_categories` is 1, because one category has no spread. Only applies when method is ml, or when support_method is alrt or abayes or shalrt. Advanced. | |
| bootstrap | 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 support_method is bootstrap. | |
| ladderize | No | order each node's children by clade size, so the drawing reads as a ladder. Changes the Newick's child order and nothing about the topology. Advanced. | |
| sequences | No | aligned sequences — wire align_sequences' rows here, or name library documents. | |
| fastme_nni | No | FastME refinement by nearest-neighbour interchange (ape's `nni = TRUE`). Only applies when method is fastme-bal or fastme-ols. Advanced. | |
| fastme_spr | No | FastME balanced refinement by subtree prune-and-regraft (ape's `spr = TRUE`). Only applies when method is fastme-bal. Advanced. | |
| ml_invariant | 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. | |
| bayesian_runs | No | independent runs (MrBayes nruns), seeded seed, seed+1, ...; 2 or more pools their samples and reports the average standard deviation of split frequencies and the PSRF. Only applies when method is bayesian. | |
| bayesian_seed | No | seed of the chain; the same seed and settings reproduce the same samples. Only applies when method is bayesian. Advanced. | |
| bayesian_temp | No | heating increment (MrBayes temp): chain j samples the posterior raised to 1/(1 + temp*j). Only applies when method is bayesian. Advanced. | |
| midpoint_root | No | root the result at its midpoint — a drawing convention, not evidence about where the true root is. Advanced. | |
| sh_replicates | 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 unless `support_method` is `shalrt`. Only applies when support_method is shalrt. Advanced. | |
| bayesian_clock | No | clock model: strict (one rate on every branch), ucln, the uncorrelated lognormal relaxed clock (each branch its own rate, mean 1, log-scale sd sampled under Exponential(mean 1/3), as BEAST's UCRelaxedClockModel), or none: an unrooted tree with free branch lengths under an Exponential prior and no coalescent (MrBayes' unconstrained model). Only applies when method is bayesian. | strict |
| bayesian_kappa | No | transition/transversion ratio for K80/HKY, held fixed. Only applies when method is bayesian. | |
| bayesian_model | No | substitution model for the Bayesian chain, its parameters held fixed for the run: base frequencies are the alignment's own for F81/HKY, and kappa is `bayesian_kappa` for K80/HKY. Values: JC69 (JC69), F81 (F81), K80 (K80), HKY (HKY). Only applies when method is bayesian. | JC69 |
| bayesian_shape | No | Gamma shape (alpha) for +G, held fixed for the run; smaller means more rate variation among sites. Only applies when method is bayesian. | |
| bootstrap_seed | 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. Advanced. | |
| support_method | 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 each internal branch against its two nearest-neighbour rearrangements under the ML model, three likelihood evaluations per branch instead of N whole re-inferences. `alrt` is the parametric test of Anisimova & Gascuel (2006), read against a mixture-of-chi-squares null, and it saturates at 99.985%. `abayes` is the Bayesian support of Anisimova et al. (2011). `shalrt` is the Shimodaira-Hasegawa-corrected variant (PhyML `-b -4`): the same three fits, but the gap is read against a null built by RELL-resampling their per-site log-likelihoods `sh_replicates` times from `bootstrap_seed` — slower than the other two, does not saturate, and usually more conservative. All three use `ml_model`/`ml_gamma_categories`/`ml_shape`/`ml_invariant` for the model, whichever `method` built the tree. Values: bootstrap (Bootstrap), alrt (aLRT), abayes (aBayes), shalrt (SH-aLRT). | bootstrap |
| bayesian_chains | No | Metropolis-coupled chains per run (MrBayes nchains; its default is 4): the extra chains sample a flattened posterior and swap states with the cold one, so a run can cross valleys a single chain cannot. Each chain costs a full chain's time. Only applies when method is bayesian. | |
| include_subject | No | also include the node's subject. | |
| bayesian_burn_in | No | iterations discarded from the start. Only applies when method is bayesian. | |
| ml_rearrangement | 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 sweeps prune-and-regraft, which reaches trees NNI cannot — at a quadratic number of rearrangements per sweep rather than a linear one. `tbr` runs both and then sweeps tree bisection and reconnection, which cuts a branch and rejoins the two halves by any pair of their branches: the largest neighbourhood here, measured at 1,950 distinct topologies against SPR's 814 on an 18-taxon tree, so roughly 2.4x an SPR sweep. Ignored unless `method` is `ml` and `ml_optimise_topology` is on. Values: nni (NNI), spr (NNI, then SPR), tbr (NNI, then SPR, then TBR). Only applies when method is ml. Advanced. | nni |
| bayesian_clock_sd | No | where the relaxed clock's sigma (log-scale sd of branch rates) starts; always sampled. Only applies when bayesian_clock is ucln. Advanced. | |
| bootstrap_measure | 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 answer no, which is why a well-supported clade can read near zero on a large tree. `tbe` is the transfer bootstrap expectation (Lemoine et al. 2018, Nature 556:452-456): 1 minus the average number of taxa that would have to move to turn a replicate's nearest branch into this one, over the branch's depth. TBE reads higher than FBP on the same replicates and the two are NOT interchangeable, so say which one a number is. Both read the SAME replicates, so `tbe` costs no extra inference. Only applies when support_method is bootstrap. | fbp |
| ml_optimise_rates | No | fit the substitution rates rather than holding the model's own. Only applies when method is ml. Advanced. | |
| ml_optimise_shape | No | fit the discrete-Γ shape rather than holding `ml_shape`. Costs a degree of freedom in AIC/BIC, and does nothing while `ml_gamma_categories` is 1. Only applies when method is ml. Advanced. | |
| pairwise_deletion | 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 ANY sequence has a gap there — turn this on for gappy alignments. | |
| bayesian_brlen_rate | No | with no clock: rate of the Exponential prior on each branch length (MrBayes brlenspr=unconstrained:exp(rate)); 10 means a prior mean of 0.1 substitutions per site. Only applies when bayesian_clock is none. Advanced. | |
| bayesian_iterations | No | Metropolis-Hastings proposals. Each rescores the alignment, so time grows with iterations x taxa x site patterns. Only applies when method is bayesian. | |
| ml_gamma_categories | 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. | |
| bayesian_theta_shape | No | shape of the Gamma prior on theta. Only applies when method is bayesian. Advanced. | |
| bayesian_theta_start | No | starting theta of the chain (not a prior). Only applies when method is bayesian. Advanced. | |
| ml_optimise_topology | 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. | |
| bayesian_sample_kappa | No | sample kappa (K80/HKY) under MrBayes' Beta(1,1) prior on kappa/(1+kappa), starting from bayesian_kappa. Only applies when method is bayesian. | |
| bayesian_sample_shape | No | sample the Gamma shape under MrBayes' Exponential(1) prior instead of holding it at bayesian_shape (which becomes the start); needs bayesian_gamma_categories > 1. Only applies when method is bayesian. | |
| ml_optimise_invariant | No | fit the proportion of invariant sites rather than holding `ml_invariant`. Costs a degree of freedom in AIC/BIC. Only applies when method is ml. Advanced. | |
| bayesian_min_part_freq | No | a clade enters the split-frequency deviation only if some run sampled it at least this share of the time (MrBayes minpartfreq). Only applies when method is bayesian. Advanced. | |
| parsimony_rearrangement | 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. Nested, not alternatives: each runs the cheaper moves first, because every NNI move is an SPR move and every SPR move is a TBR move. `tbr` searches the largest neighbourhood this tool offers — 1,950 distinct topologies against SPR's 814 on an 18-taxon tree — and rescores each candidate whole, where SPR scores incrementally, so it is markedly the slowest. Values: nni (Nearest-neighbour interchange), spr (Subtree prune-and-regraft), tbr (Tree bisection and reconnection). Only applies when method is parsimony. Advanced. | nni |
| bayesian_gamma_categories | No | discrete-Gamma categories for among-site rate variation (+G, each category its bin mean); 1 is equal rates. Only applies when method is bayesian. | |
| bayesian_sample_frequency | No | keep one tree every this many iterations after burn-in. Only applies when method is bayesian. Advanced. | |
| bayesian_theta_prior_mean | No | mean of the Gamma prior on theta = 4N mu, in substitutions per site. Only applies when method is bayesian. Advanced. | |
| bayesian_sample_frequencies | No | sample the base frequencies (F81/HKY) under a flat Dirichlet, starting from the alignment's own. Only applies when method is bayesian. | |
| ml_optimise_base_frequencies | No | fit base frequencies rather than holding them equal. Only applies when method is ml. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| gamma | Yes | the Pybus-Harvey gamma statistic: negative if branching clusters toward the root (an early burst), positive if toward the tips. A standard normal deviate under the constant-rate null — read it with `gammaP`, and only if `clockDeviationInBranches` is below 1 |
| gammaP | Yes | two-tailed P for `gamma` against the constant-rate (pure-birth) null |
| newick | Yes | the tree in Newick format |
| bayesian | Yes | under `method: bayesian`: the chain (iterations, burn-in, samples, seed, acceptance per operator), the fixed model, the priors, mean / 95% HPD / ESS of log L, theta and root height, every clade's posterior probability (0..1), the commonest topologies and the highest-posterior state. Absent under every other method |
| tipCount | Yes | number of tips (leaves) |
| transfer | Yes | under `support_method: bootstrap` with `bootstrap_measure: tbe`: per branch, its clade (the smaller side), its depth, the mean transfer distance over the replicates and the support on 0..1. Absent under `fbp`, which puts its values on the tree and nowhere else |
| warnings | Yes | what the method had to say about the data |
| statistics | Yes | tree statistics: tips, height, total length, diameter, the branch-length distribution, Colless/Sackin imbalance, cherries, treeness, the Pybus-Harvey gamma with its two-tailed P, and the ultrametricity readouts gamma depends on (`isUltrametric`, `rootToTipSpread`, `clockDeviationInBranches`) |
| distanceMap | Yes | that distance matrix as a heatmap |
| branchSupport | Yes | under `alrt`/`abayes`: the measure, the model, the tree's log-likelihood, and per branch its clade, the two alternative log-likelihoods, the statistic and the support (a fraction, not a percentage). Absent under `bootstrap` |
| distanceMatrix | Yes | the pairwise distance matrix the tree was built from |
| clockDeviationInBranches | Yes | how far from clock-like the tree is, in MEAN BRANCH LENGTHS. `gamma` and any lineages-through-time reading assume an ultrametric tree; below 1 the raggedness cannot reorder a branching event, above it the statistic is partly rate variation and is not a diversification result |
calculate_powerARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| N | No | total observations across every cell. Only applies when test is chisq. | |
| k | No | number of groups. Only applies when test is anova. | |
| n | 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 or proportions_raw or anova_raw. | |
| u | No | numerator degrees of freedom: the number of predictors tested. Only applies when test is linear_model. | |
| v | No | denominator degrees of freedom: n − u − 1 for n observations. Only applies when test is linear_model. | |
| df | 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. | |
| n1 | No | observations in the first group. Only applies when test is t_unequal or two_proportions_unequal. | |
| n2 | No | observations in the second group. Only applies when test is t_unequal or two_proportions_unequal. | |
| p1 | No | the proportion in group 1. Only applies when test is proportions_raw. | |
| p2 | No | the proportion in group 2. Only applies when test is proportions_raw. | |
| sd | 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. | |
| test | 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, unequal group sizes, Cohen's d), two_proportions (two proportions, equal n, Cohen's h), two_proportions_unequal (two proportions, unequal n, Cohen's h), one_proportion (one proportion against a null value, Cohen's h), normal_mean (normal mean, known variance, effect d), correlation (Pearson correlation, r), chisq (chi-square goodness of fit or independence, Cohen's w), anova (balanced one-way ANOVA, Cohen's f), linear_model (linear model F test (multiple regression), Cohen's f²), t_raw (t test in raw units: difference and standard deviation), proportions_raw (two proportions in raw units: p1 and p2), anova_raw (balanced one-way ANOVA in raw units: between- and within-group variance). | |
| type | No | the t test's design. Only applies when test is t or t_raw. | two.sample |
| power | No | 1 − β, the chance of detecting the effect if it is real. No default: the target is yours to choose. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| effect | 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. Only applies when test is t or t_unequal or two_proportions or two_proportions_unequal or one_proportion or normal_mean or correlation or chisq or anova or linear_model. | |
| groups | No | number of groups. Only applies when test is anova_raw. | |
| strict | No | two-sided raw-unit tests: also count rejections in the wrong tail, as R's strict = TRUE. Only applies when test is t_raw or proportions_raw. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sig_level | No | α, the type I error rate; R's default. | |
| solve_for | 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. | |
| difference | No | δ, the true difference in means, in the measurement's units. Only applies when test is t_raw. | |
| within_var | No | variance within groups. Only applies when test is anova_raw. | |
| alternative | No | two-sided, or the direction a one-sided test looks in (the raw-unit t and proportion tests take only two.sided or one.sided). Only applies when test is t or t_unequal or two_proportions or two_proportions_unequal or one_proportion or normal_mean or correlation or t_raw or proportions_raw. | two.sided |
| between_var | No | variance of the group means. Only applies when test is anova_raw. | |
| effect_size | 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 applies when test is t or t_unequal or two_proportions or two_proportions_unequal or one_proportion or normal_mean or correlation or chisq or anova or linear_model. |
Output Schema
| Name | Required | Description |
|---|---|---|
| power | Yes | the power of the design |
| rCall | Yes | the R call that reproduces the answer |
| value | Yes | the solved quantity's value |
| solved | Yes | which quantity was solved |
| values | Yes | every quantity of the test, the solved one included, by R's name |
| warnings | Yes | R's own warnings for this solve, verbatim |
| powerCurve | Yes | power against the sample size, every other quantity held |
| wholeUnits | Yes | the sample size rounded up to whole units and the power that whole number gives |
calculate_rnaseq_powerARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| n | No | biological replicates in group 1 (and in group 2, unless `n2` is given). | |
| cv | 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.). | |
| n2 | No | replicates in group 2, one per `n`. Advanced. | |
| cv2 | No | the CV within group 2, one per `cv`. Advanced. | |
| alpha | No | α, the two-sided false-positive rate per gene. | |
| depth | 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. | |
| power | No | 1 − β, the chance of detecting the change if it is real. No default: the target is yours to choose. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| effect | No | the fold change to detect; 2 and 0.5 are the same change. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| solve_for | 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). |
Output Schema
| Name | Required | Description |
|---|---|---|
| grid | Yes | every design in the grid: each quantity, and the solved one |
| curve | Yes | the solved quantity along the first quantity given as a list, one line per value of the second |
| rCall | Yes | the R call that reproduces the grid |
| value | Yes | the solved value, when the design is a single cell |
| solved | Yes | which quantity was solved |
call_bases_from_traceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| table | 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. | 3730pop7 |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| bases | Yes | how many bases the reading called |
| meanQuality | Yes | the mean Phred of the reading, on the calibration table it names |
| instrumentBases | Yes | how many the FILE carries, so a gate can see a de-novo reading change the read's length |
call_cqARead-onlyInspect
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 rather than hidden behind it.
| Name | Required | Description | Default |
|---|---|---|---|
| model | 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 (l6 · + linear baseline drift), l7 (l7 · + quadratic baseline), b4 (b4 · 4-param logistic (raw scale)), b5 (b5 · + asymmetry), b6 (b6 · + linear baseline drift), b7 (b7 · + quadratic baseline). | l4 |
| shift | No | cycles added to every reported Cq, for aligning against an instrument's own numbering. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| curves | 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. | |
| amounts | 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 `init1`, the fit's fluorescence at cycle 0, which is what an absolute quantification scales an unknown's `init1` by. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cq_method | 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 of maximum efficiency), expR (expR · exponential region), Cy0 (Cy0 · tangent x-intercept (Guescini)), CQ (CQ · 20 % of the Cq fluorescence), maxRatio (maxRatio · spline, model-free (Shain)). | cpD2 |
| criterion | 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 cycle and the only honest source is the plate's own replicates, so it REFUSES a plate with none. Values: ftest (Nested F-test (within family)), ratio (Likelihood ratio (within family)), weights (AICc weights (all eight models)), chisq (Reduced chi-square (needs replicates)). Only applies when auto_model is true. | ftest |
| threshold | 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 reads the Cq under `cq_method`. A reaction that never reaches it has no Cq and says so. | |
| auto_model | 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 which model won and the full ranking table. | |
| baseline_to | No | last cycle of that window. In cycle. Advanced. | |
| baseline_from | 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_scan | 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 of the bundled Own Mix B plate: scanning gives a median efficiency disagreement of 0.038, not scanning gives 0.460. The result reports what the other setting would have returned, so the choice is never hidden. In SD. Advanced. | |
| outlier_method | 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 dirty under another. Values: uni1 (Efficiency Z-score (Bar)), uni2 (Shape: cpD1 − cpD2 (Tichopad)), multi1 (Multivariate: cpD1 vs cpD2 residual (Tichopad MOD1)), multi2 (Multivariate: slope, Fmax (Tichopad MOD2)), multi3 (Multivariate: slope, F at cpD1, Fmax (Sisti)). Advanced. | uni2 |
| max_ratio_smooth | 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. | |
| max_ratio_baseshift | 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 when cq_method is maxRatio. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | one row per reaction: Cq, cpD1, cpD2, efficiency, the fit-quality block, take-off and midpoint, the initial fluorescence two ways (`init1` the fit at cycle 0, `init2` the fluorescence at the Cq over E^Cq), and `cf`, the known amount over `init1` for a reaction given one (NaN otherwise) |
| count | Yes | how many reactions were fitted |
| model | Yes | the model that produced these Cqs, named: a Cq without its model is not comparable, and under `auto_model` this is the one that WON rather than the one you asked for |
| failed | Yes | reactions whose fit did not converge. A non-zero count is a finding about the plate, not a warning to swallow |
| methods | Yes | the all-methods table: the same reactions measured four independent ways (sigmoidal fit, sliwin, expfit, LRE) with each failure NAMED, plus what sliwin returns under the other baseline setting. Agreement between them is the evidence a well is clean |
| cqMethod | Yes | the Cq definition used: `cpT` when a `threshold` was set, since a threshold overrides `cq_method` |
| outliers | Yes | the kinetic-outlier verdicts, including the reactions the test could not MEASURE — reported as not judged with the reason, never as passing |
| errorNote | Yes | a plate-level note from the fit (for example a reaction the model could not fit); null when there is none |
| threshold | Yes | the fluorescence threshold every Cq was read at; null when the Cq came from `cq_method` instead |
| modelTable | Yes | the full model ranking when `auto_model` chose one — logLik, AIC, AICc, residual variance, F test, likelihood ratio, AICc weight and reduced chi-square per model. Null when the model was given rather than chosen |
| modelChosen | Yes | the curve model the ranking chose when the model was not given; null when it was given |
| outlierStat | Yes | which statistic judged them, or the refusal when the plate could not support the test |
| zeroCrossing | Yes | reactions whose fluorescence crosses zero after `max_ratio_baseshift` is added, where the spline estimators put a pole in the series and would return a confident 1e16. Named rather than printed |
| meanEfficiency | Yes | mean per-reaction efficiency over the reactions that fitted, as a percentage |
| amplificationPlot | Yes | the raw amplification curves as read from the plate, one line per reaction, fluorescence against cycle |
call_mixed_bases_from_traceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | het = the two alleles are assumed present 1:1 (a diploid heterozygote); mix = no assumption is made about their ratio. | het |
| table | 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. | 3730pop7 |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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. | |
| min_ratio | 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 mixed bases. |
Output Schema
| Name | Required | Description |
|---|---|---|
| bases | Yes | how many bases the reading called |
| mixedBases | Yes | how many positions were called as carrying two alleles. Reported as 0 rather than omitted when none were, because a missing field is not an answer |
| meanQuality | Yes | the mean Phred of the reading, on the calibration table it names |
| instrumentBases | Yes | how many the FILE carries, so a gate can see a de-novo reading change the read's length |
cancel_research_runBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| run | Yes | the run file to cancel pending hypotheses in. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| reason | No | why, recorded on each canceled attempt. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| hypotheses | No | the pending hypotheses to cancel, by id; unset cancels every pending one. |
Output Schema
| Name | Required | Description |
|---|---|---|
| run | Yes | the whole program as a sealed jane.research-run file: the ledger, every corpus input pinned by SHA-256, the last attempt at each hypothesis. Pass it back to continue |
| status | Yes | the canceled run's status: counts, pending (now none of the canceled), settled and canceled hypotheses |
| cancelled | Yes | the hypotheses this call canceled |
canonical_tautomerARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| molecule | Yes | the structure: SMILES or a molfile. | |
| max_tautomers | No | stop the enumeration at this many tautomers. | |
| max_transforms | No | stop after this many transform applications. |
Output Schema
| Name | Required | Description |
|---|---|---|
| summary | Yes | the enumeration in words, with the cap when one was reached |
| canonical | Yes | RDKit's canonical tautomer, as canonical SMILES |
| tautomers | Yes | every tautomer enumerated, as canonical SMILES, sorted |
check_assay_decayARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| assay | No | what the assay is called, for the result to name. | assay |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| probes | No | the assay's probes, 5′→3′. Scored the same way but with no 3′-end rule: a probe is not extended. | |
| primers | No | the assay's primers, 5′→3′, IUPAC allowed. Written `name=SEQUENCE` to carry the published name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequences | Yes | the genomes to check against: wire upstream records here, or list library document names. | |
| include_subject | No | also check the node's subject (the open or wired record). | |
| three_prime_window | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| sites | Yes | every (oligo, genome) site: strand, start, the mismatching positions and whether the genome could be scored |
| worst | Yes | the oligo with the highest mismatch rate, which is the one that decides the assay |
| oligos | Yes | per oligo: genomes scored, genomes with a mismatch, the rate and its exact 95% interval, the 3′-end count, and the mismatch count at each position |
| result | Yes | the full result |
| worstRate | Yes | that oligo's mismatch rate, for a threshold downstream |
| threePrime | Yes | how many (primer, genome) pairs carry a mismatch in the 3′-end window |
check_color_balanceARead-onlyInspect
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 base from A to C and a set balanced on a NovaSeq 6000 is not balanced on a NovaSeq X.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| barcodes | Yes | the index sequences to score, one per sample. | |
| instrument | No | the instrument whose chemistry the set is judged under, and whose index-2 orientation applies. | NovaSeq X / X Plus |
Output Schema
| Name | Required | Description |
|---|---|---|
| ok | Yes | whether the set clears every rule for this chemistry |
| tier | Yes | Illumina's own grading of this set on this instrument: `ideal`, `acceptable` or `unacceptable` |
| cycles | Yes | per-cycle channel occupancy — the census the tier is computed from |
| violations | Yes | each rule broken, the cycles it was broken at, and the vendor article it comes from |
| channelPlot | Yes | the fraction of the pool producing signal in each channel at each index cycle; the series are named after the channels, and their colors are not the dyes |
| acrossChemistries | Yes | the SAME set scored under every chemistry generation, so a set that passes here and fails on another instrument says so before the run |
check_flow_cytometry_qualityBRead-onlyInspect
Acquisition quality over time for an FCS file, by flowAI (flow rate, signal acquisition and dynamic range checks), PeacoQC (peak trajectories, isolation tree and MAD) or flowCut (deviant and low-density segments).
| Name | Required | Description | Default |
|---|---|---|---|
| A | No | additional negative decades. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| M | No | decades of the full scale. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| T | No | top of scale; empty means the file's largest fluorescence $PnR. | |
| W | No | linear width in decades. Only applies when scale is logicle or hyperlog or flowcore-logicle. | |
| tool | No | the method. Values: flowai (flowAI), peacoqc (PeacoQC), flowcut (flowCut). | flowai |
| scale | No | the display scale of the fluorescence channels (scatter and time stay linear): used for the plot, the threshold and, with `stats_on: scaled`, the statistics. Values: logicle (Logicle (Gating-ML 2.0, Moore & Parks)), fasinh (ArcSinh (Gating-ML 2.0 fasinh)), arcsinh (ArcSinh with a cofactor (asinh(x / c), Cytobank and CyTOF)), hyperlog (Hyperlog (Gating-ML 2.0, Bagwell)), flowcore-logicle (Logicle on a 0–M axis (flowCore)), wsp-biex (Biex (FlowJo 10, channels 0–4096)), flin (Linear (Gating-ML flin)). | logicle |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| gating | No | a Gating-ML 2.0 document in the project, by name or id; empty for no gating (every statistic is then of all events). | |
| plot_x | No | channel (PnN or PnS) on the density plot's x axis; empty for no plot. | |
| plot_y | No | channel on the plot's y axis. | |
| derived | No | derived parameters, `name = expression` separated by `;` (FlowJo's vocabulary: channels by name or [name], + − * / % ^, abs ceil floor neg round max min pow exp ln log sqrt and the trig functions); each becomes a channel of the run. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cofactor | No | the c in asinh(x / c): 5 is the CyTOF convention, 150 a common one for fluorescence. Only applies when scale is arcsinh. | |
| document | No | the FCS file, by name or id; may be left empty when the project holds exactly one. | |
| peaco_mad | No | PeacoQC MAD. Only applies when tool is peacoqc. | |
| biex_width | No | FlowJo biex width basis (negative; FlowJo's default -10). Only applies when scale is wsp-biex. | |
| compensation | No | `auto`: the file's own $SPILLOVER/$SPILL when it has one, else none; `file`: that, refusing a file without one; `none`: leave the values as acquired. Values: auto (automatic), file (file's own matrix), none (none). | auto |
| biex_negative | No | FlowJo biex extra negative decades. Only applies when scale is wsp-biex. | |
| peaco_it_limit | No | PeacoQC isolation tree limit. Only applies when tool is peacoqc. | |
| flowcut_segment | No | flowCut segment (events). Only applies when tool is flowcut. | |
| plot_population | No | the population plotted; empty for all events. | |
| peaco_consecutive | No | PeacoQC consecutive bins. Only applies when tool is peacoqc. | |
| flowai_remove_from | No | flowAI: which checks remove events. Only applies when tool is flowai. | all |
| compensation_method | No | which published algorithm: FlowKit's solve(Sᵀ, Xᵀ) or flowCore's X · S⁻¹. They agree to ~1e-15 of full scale. Values: flowkit (solve(Sᵀ, Xᵀ) (FlowKit)), flowcore (X · S⁻¹ (flowCore)). Only applies when compensation is auto or file. | flowkit |
| flowcut_max_perc_cut | No | flowCut MaxPercCut. Only applies when tool is flowcut. | |
| flowcut_max_valley_hgt | No | flowCut MaxValleyHgt. Only applies when tool is flowcut. |
Output Schema
| Name | Required | Description |
|---|---|---|
| kept | Yes | events kept |
| table | Yes | the method's own result table |
| causes | Yes | per cause: events flagged, whether it removes, and flagged events per time bin |
| channels | Yes | the per-channel table (changepoints, MAD contribution, margins) |
check_golden_gate_partsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| parts | No | the parts to check — wire upstream `record` outputs here, or list library document names/ids. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzyme | No | the Type-IIS enzyme the assembly will use. | BsaI |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| include_subject | No | also check the node's subject. |
Output Schema
| Name | Required | Description |
|---|---|---|
| parts | Yes | one row per part: site count, internal-site count, whether it is assembly-ready, and the problem when it is not |
| ready | Yes | true when every part carries exactly its two flanking sites |
| internalSiteCount | Yes | internal sites across all parts — the number that must reach zero |
| needsDomestication | Yes | the parts carrying internal sites, each with every offending site's position and strand |
check_index_poolARead-onlyInspect
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 are in use, and which swaps would turn one sample's read into another's undetectably.
| Name | Required | Description | Default |
|---|---|---|---|
| kit | 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 Indexes — Illumina, 24 indexes), truseq-cd-indexes (TruSeq DNA and RNA CD Indexes — Illumina, 96 indexes), idt-truseq-ud-indexes (IDT for Illumina–TruSeq DNA and RNA UD Indexes — Illumina / IDT, 100 indexes), idt-illumina-ud-plate-a (IDT for Illumina UD Indexes, Plate A/Set 1 — Illumina / IDT, 96 indexes), idt-illumina-ud-plate-b (IDT for Illumina UD Indexes, Plate B/Set 2 — Illumina / IDT, 96 indexes), idt-illumina-ud-plate-c (IDT for Illumina UD Indexes, Plate C/Set 3 — Illumina / IDT, 98 indexes), idt-illumina-ud-plate-d (IDT for Illumina UD Indexes, Plate D/Set 4 — Illumina / IDT, 100 indexes). Only applies when pool is not given. | |
| pool | 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 dropped. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| metric | 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)), levenshtein (Levenshtein). | seqlev |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| i5_cycles | No | index-2 read length from the run recipe. 0 = use the indexes' own length. | |
| i7_cycles | 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. | |
| instrument | 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. | NovaSeq X / X Plus |
| library_prep | 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 for your run. Values: patterned-examp (Patterned flow cell, ExAmp chemistry), truseq-pcr-free (TruSeq PCR-Free libraries). | patterned-examp |
| required_distance | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| reads | Yes | per index read: cycles, color-balance tier and the per-cycle channel census |
| checks | Yes | every check with its own result — a check with no input to run against reports SKIPPED, never passed |
| hopping | Yes | index-hopping exposure: combinations possible against combinations in use, the removable share, and the undetectable swaps. Absent for a single-index pool, which has no i5 to swap. |
| samples | Yes | how many samples were checked |
| skipped | Yes | rows the parse could not read, each with its line number and the reason — these are usually WHY a check refused |
| verdict | Yes | the pool-level verdict: `ok`, `warning` or `fail` |
| failures | Yes | checks that FAILED — a warn and a skip are each counted by their own status in `checks`, never folded in here |
| guarantee | Yes | how many errors this pool can CORRECT and DETECT under the chosen metric — the number the whole check exists to establish |
| closestPairs | Yes | the pairs that get confused first |
check_invariantsBRead-onlyInspect
Decide whether a sequence is scientifically admissible: protein unchanged, forbidden restriction sites absent, reading frame intact, length/GC/CAI inside stated bounds.
| Name | Required | Description | Default |
|---|---|---|---|
| table | No | NCBI translation table. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| max_gc | No | maximum GC fraction (0-1). | |
| min_gc | No | minimum GC fraction (0-1). | |
| min_cai | No | minimum CAI (needs cai_organism). Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the sequence to judge — defaults to the open record. | |
| gc_window | 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. | |
| max_length | No | maximum length [bp]. In bp. Advanced. | |
| min_length | No | minimum length [bp]. In bp. Advanced. | |
| cai_organism | No | host for the codon-adaptation check, e.g. sce. Advanced. | |
| forbid_sites | No | enzyme names that must not cut, e.g. BsaI, BsmBI. | |
| require_stop | No | with require_frame: the last codon must be a stop. Only applies when require_frame is true. Advanced. | |
| require_frame | No | length divisible by 3 and no premature stop. | |
| require_start | No | with require_frame: the first codon must be a start codon. Only applies when require_frame is true. Advanced. | |
| preserve_protein_of | No | the ORIGINAL coding sequence (or its protein): the result must still translate to it. |
Output Schema
| Name | Required | Description |
|---|---|---|
| failed | Yes | how many invariants did not hold |
| checked | Yes | how many invariants were asked |
| summary | Yes | one line per failure: value, requirement, remedy |
| verdicts | Yes | per-invariant verdicts, with breach coordinates |
| admissible | Yes | every invariant was decided and held |
check_manufacturabilityARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| vendor | 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 eBlocks Gene Fragments), twist-clonal (Twist Bioscience Clonal Genes), twist-fragments (Twist Bioscience Gene Fragments). | idt-gblocks |
| feature | 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 | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the sequence to measure. Leave unset to use the open record, or the current selection when there is one. |
Output Schema
| Name | Required | Description |
|---|---|---|
| spans | Yes | just the spans of the exceeded limits, 0-based half-open, ready to draw on the map — the half of a finding a user cannot act on without |
| checked | Yes | how many limits were graded. Read it beside `outside`: 0 of 4 and 0 of 7 are different answers, because vendors publish different numbers of limits |
| outside | Yes | how many published limits this sequence exceeds — the number to branch a workflow on |
| profile | Yes | the vendor profile every verdict here was made against, including the page it was read from and the date — a threshold whose source is not stated is not checkable |
| reading | Yes | the report in words, generated from the findings: which limits are exceeded by how much, what could not be graded, and the standing qualification that published support is not a refusal policy |
| verdict | Yes | `within` when every published limit is met, `outside` when any is exceeded. Not a prediction and not a refusal: it is whether the sequence sits inside the envelope the vendor publishes |
| findings | Yes | every limit, met or not, with what this sequence measures, what the vendor publishes, and the span it is about where it has one |
| notGraded | Yes | limits the vendor publishes that this sequence could not be graded on, each with the reason. A 40 bp insert has no 50 bp GC window, and silence would make a shorter sequence look like a cleaner one |
| repeatScreens | Yes | the Synthesis Success Calculator's six published repeat-density screens (Halper, Hossain & Salis 2020), independent of vendor: each with its rule, whether it fires (null where it does not apply, as the 500 bp window under 1,000 bp), what was measured and the first span that tripped it. Rules from the literature, not a vendor's acceptance limits |
check_methylation_blockARead-onlyInspect
Whether the host's own methylation blocks the given enzymes ON THIS PLASMID, from REBASE's methylation-sensitivity tables localised onto your sites.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | 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 | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| blocked | Yes | how many of the enzymes are blocked or impaired at at least one site HERE — branch on this rather than on the presence of a verdict, because a `cut` verdict is also a verdict |
| enzymes | Yes | per enzyme: its REBASE recognition site, how many sites this molecule carries, whether REBASE has examined it, and one verdict row per methylase localised onto those sites |
| unexamined | Yes | how many of the enzymes REBASE has NOT tested against any methylase |
| blockedEnzymes | Yes | the names of those enzymes, for a message that says which one to swap |
check_primer_specificityARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | ||
| pairs | 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. | |
| top_n | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| forward | No | one pair's forward primer, 5'→3' (wire design_primers' `forward`). | |
| reverse | No | that pair's reverse primer, 5'→3' (wire design_primers' `reverse`). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| database | 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. | |
| template | 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 as unintended and the result says so. |
Output Schema
| Name | Required | Description |
|---|---|---|
| ranked | Yes | every pair in ranked order: its design rank, standing (specific, unchecked, non-specific), intended products and unintended products with subject, span, length and mismatches |
| forward | Yes | the top-ranked pair's forward primer (wire into pcr_amplify) |
| reverse | Yes | the top-ranked pair's reverse primer |
| identical | Yes | database records identical to the template, whose products are the intended ones |
| specificCount | Yes | pairs with no product off the template; wire into a $when to branch on "any specific pair" |
check_rowsBRead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| max | No | upper bound, inclusive. Only applies when operator is between. | |
| min | No | lower bound, inclusive. Only applies when operator is between. | |
| set | No | the values the field must be one of (or none of). Only applies when operator is in or not_in. | |
| text | No | the text the field must contain. Only applies when operator is contains. | |
| count | No | N, for the counted requirements. Only applies when require is at_least or at_most or exactly. | |
| field | No | which field of each row to test (e.g. `size`, `score`). Leave empty when the rows are plain numbers. | |
| items | Yes | the rows to check. Wire a json/list output (bands, guides, assays, amplicons). | |
| label | No | what this gate is checking, in your words. It becomes the message when it fails. | |
| value | No | the value to compare against. Only applies when operator is == or != or > or >= or < or <=. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| record | 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. | |
| require | 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). | all |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| operator | 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), contains (contains text), is_true (is true), not_empty (is not empty). | >= |
| report_only | No | report the verdict instead of stopping the run: wire `passed` (or `failed`) into another step's condition to choose a branch. |
Output Schema
| Name | Required | Description |
|---|---|---|
| failed | Yes | the opposite verdict, so the ELSE arm of a branch needs no extra step. Only meaningful with `report_only` on |
| passed | Yes | whether the requirement held. As a gate this is true whenever it is read downstream; with `report_only` on it is the real verdict, for driving a branch |
| record | Yes | the guarded record, unchanged. Wire it into the next node's $subject to make that step conditional |
| matched | Yes | how many rows met the per-row condition |
| message | Yes | what was checked, in words |
| offenders | Yes | the rows that did NOT meet it: what to look at when the gate fails |
check_scorpion_stemBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| probe | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| margin | 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 primary literature. In °C. | |
| target | 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-structure. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| conditions | 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 defaults when there are none. Advanced. | |
| stem_length | 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 tool says 6-7 - so neither is enforced. In nt. |
Output Schema
| Name | Required | Description |
|---|---|---|
| notes | Yes | why a temperature is missing, in the words the panel shows. Empty when both were computed |
| stemTm | Yes | melting temperature of the probe element's own hairpin, °C - null when no stem forms |
| probeTm | Yes | melting temperature of the loop-target duplex, °C |
| difference | Yes | stemTm - probeTm, the quantity the design rule is about |
| clearsMargin | Yes | whether the difference clears the margin GIVEN - null when either temperature could not be computed |
| marginSource | Yes | where the margin came from, carried with the verdict so an unsourced rule of thumb is never mistaken for a measurement |
| stemGcPercent | Yes | GC of the 5' stem arm - both vendors ask for a GC-rich stem |
check_valueARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| max | No | upper bound, inclusive. Only applies when operator is between. | |
| min | No | lower bound, inclusive. Only applies when operator is between. | |
| set | 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 | No | the text the value must contain. Only applies when operator is contains. | |
| label | No | what this gate is checking, in your words — it becomes the message when the gate fails (e.g. 'single EcoRI site'). | |
| value | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| record | 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. | |
| against | 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 <=. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| operator | 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 (contains text), is_true (is true), not_empty (is not empty). | >= |
| threshold | 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 <=. | |
| report_only | No | report the verdict instead of stopping the run: wire `passed` (or `failed`) into another step's condition to choose a branch. | |
| against_factor | 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 | 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 <=. |
Output Schema
| Name | Required | Description |
|---|---|---|
| value | Yes | the value that was checked, passed straight through so the gate can sit mid-chain |
| failed | Yes | the opposite verdict, so the ELSE arm of a branch needs no extra step. Only meaningful with `report_only` on |
| passed | Yes | whether the check held. As a gate this is true whenever it is read downstream, since a failure stops the run; with `report_only` on it is the real verdict, for driving a branch |
| record | Yes | the guarded record, unchanged — wire it into the next node's $subject to make that step conditional on this check |
| message | Yes | what was compared, in words |
classify_dropletsCRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| k | No | for `knn`: how many nearest labelled neighbours vote. Only applies when method is knn. | |
| prob | 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 every droplet the vote decided at all. Only applies when method is knn. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| ch1_nn | No | grid: Ch1 below this and Ch2 below `ch2_nn` is NN. Only applies when method is grid. | |
| ch1_np | No | grid: Ch1 below this and Ch2 above `ch2_np` is NP. Only applies when method is grid. | |
| ch1_pn | No | grid: Ch1 above this and Ch2 below `ch2_pn` is PN. Only applies when method is grid. | |
| ch1_pp | No | grid: Ch1 above this and Ch2 above `ch2_pp` is PP. Only applies when method is grid. | |
| ch2_nn | No | grid: the Ch2 half of the NN box. Only applies when method is grid. | |
| ch2_np | No | grid: the Ch2 half of the NP box. Only applies when method is grid. | |
| ch2_pn | No | grid: the Ch2 half of the PN box. Only applies when method is grid. | |
| ch2_pp | No | grid: the Ch2 half of the PP box. Only applies when method is grid. | |
| method | 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; `density`, `samspectral`, `flowpeaks` and `ensemble` (ddPCRclust) are for one to four targets and name populations by marker number (`1`, `1+2`, ...); `ensemble` runs the other three and is the slowest. | kmeans |
| markers | 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 well whose cluster 2 is missing. The number of names is the number of targets. Only applies when method is density or samspectral or flowpeaks or ensemble. | M1,M2,M3,M4 |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| droplets | 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 PLATE: each export as `# <file name>` then its CSV, separated by a line of `---`, the well id read from the file name (`..._B01_Amplitude.csv`). | |
| sam_seed | 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 `ddPCRclust()` does. Only applies when method is samspectral or ensemble. | |
| template | 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 takes its own row's markers instead of `markers`. Only applies when method is density or samspectral or flowpeaks or ensemble. | |
| training | 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 neighbours, separately from the probability floor below. Only applies when method is knn. | |
| random_seed | 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 it does, and a deterministic tie-break would be stable and wrong. Only applies when method is knn. | |
| sensitivity | 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 is density or samspectral or flowpeaks or ensemble. | |
| distance_param | 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 ensemble. | |
| constant_control | 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, as `calculateCPDs(constantControl =)` does. Empty: no normalisation. Only applies when method is density or samspectral or flowpeaks or ensemble. |
Output Schema
| Name | Required | Description |
|---|---|---|
| total | Yes | droplets classified — the denominator the counts sum to |
| wells | Yes | for a PLATE: every well's counts, copies per droplet, confidence and members, or the reason no member could partition it. `classes`, `counts` and `total` are empty for a plate |
| counts | Yes | droplets per class, which is what a copy-number read consumes next. Rain is reported separately and is never folded into a population |
| method | Yes | which classifier produced this. A classification without its method is not comparable with another, because the three disagree on the droplets between populations |
| params | Yes | every parameter the run used, defaults included: the thresholds, k and the floor each move the answer |
| centres | Yes | for `kmeans`: the final cluster centres with the name geometry gave each one; for `density`: the primary cluster centres, named by marker. Empty for the other methods, which have no centres |
| classes | Yes | one label per droplet, in the order given: NN, NP, PN, PP, or Rain where the method abstained |
| members | Yes | for the ddPCRclust methods: each first clustering that ran, with its population counts or the error that left it out of the consensus. `ensemble` is only as good as the members that agreed |
| confidence | Yes | for the ddPCRclust methods: the mean corrected Rand index between the member partitions (1 when one member answered). Low means the three first clusterings disagree about this well |
| normalised | Yes | for a PLATE with `constant_control`: every well's copies per droplet after scaling to the control's highest value on the plate, with each well's factor. Null without a control |
| copies_per_droplet | Yes | for the ddPCRclust methods on one well: each named marker's positive droplets (every population carrying it) and its copies per droplet, -ln(1 - positives / total). Empty for the two-target methods |
classify_grammar_partBRead-onlyInspect
Which Golden Braid / MoClo / Yeast ToolKit grammar, position and level the open plasmid represents (or null).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| level | Yes | assembly level |
| spans | Yes | for a COMPOSITE position, the slots it occupies end to end (YTK Type 234 spans 2, 3 and 4); empty otherwise |
| grammar | Yes | grammar name, or empty when unclassified |
| isVector | Yes | true when a part at this position is also the acceptor backbone for its level (YTK Type 8, 8a, 678) |
| position | Yes | position name within the grammar |
| releaseCuts | Yes | how many times the release enzyme cut. 2 for a clean excise; 3 for a GoldenBraid Level-0 module, whose pUPD backbone carries its own site, so the backbone is released in two pieces and the insert is identified by carrying no backbone marker |
| releaseEnzyme | Yes | enzyme that releases the part |
| classification | Yes | the full classification (null when no grammar matches) |
cluster_flow_cytometry_flowsomBRead-onlyInspect
FlowSOM on an FCS file's population: a self-organizing map of the chosen channels (fluorescence on the display scale), its nodes joined by their minimum spanning tree, grouped into metaclusters by ConsensusClusterPlus, with per-node marker medians, shares of events and FlowSOM's TestOutliers report.
| Name | Required | Description | Default |
|---|---|---|---|
| A | No | additional negative decades. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| M | No | decades of the full scale. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| T | No | top of scale; empty means the file's largest fluorescence $PnR. | |
| W | No | linear width in decades. Only applies when scale is logicle or hyperlog or flowcore-logicle. | |
| rlen | No | training passes over the data. | |
| seed | No | R set.seed for the map and the metaclustering. | |
| xdim | No | grid width. | |
| ydim | No | grid height. | |
| scale | No | the display scale of the fluorescence channels (scatter and time stay linear): used for the plot, the threshold and, with `stats_on: scaled`, the statistics. Values: logicle (Logicle (Gating-ML 2.0, Moore & Parks)), fasinh (ArcSinh (Gating-ML 2.0 fasinh)), arcsinh (ArcSinh with a cofactor (asinh(x / c), Cytobank and CyTOF)), hyperlog (Hyperlog (Gating-ML 2.0, Bagwell)), flowcore-logicle (Logicle on a 0–M axis (flowCore)), wsp-biex (Biex (FlowJo 10, channels 0–4096)), flin (Linear (Gating-ML flin)). | logicle |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| gating | No | a Gating-ML 2.0 document in the project, by name or id; empty for no gating (every statistic is then of all events). | |
| n_clus | No | metaclusters. | |
| plot_x | No | channel (PnN or PnS) on the density plot's x axis; empty for no plot. | |
| plot_y | No | channel on the plot's y axis. | |
| derived | No | derived parameters, `name = expression` separated by `;` (FlowJo's vocabulary: channels by name or [name], + − * / % ^, abs ceil floor neg round max min pow exp ln log sqrt and the trig functions); each becomes a channel of the run. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| channels | No | channels to build the map on, comma-separated; empty for every fluorescence channel. | |
| cofactor | No | the c in asinh(x / c): 5 is the CyTOF convention, 150 a common one for fluorescence. Only applies when scale is arcsinh. | |
| document | No | the FCS file, by name or id; may be left empty when the project holds exactly one. | |
| biex_width | No | FlowJo biex width basis (negative; FlowJo's default -10). Only applies when scale is wsp-biex. | |
| outlier_mad | No | TestOutliers madAllowed. | |
| standardize | No | FlowSOM scale = TRUE: centre and divide each channel by its SD first. | |
| compensation | No | `auto`: the file's own $SPILLOVER/$SPILL when it has one, else none; `file`: that, refusing a file without one; `none`: leave the values as acquired. Values: auto (automatic), file (file's own matrix), none (none). | auto |
| biex_negative | No | FlowJo biex extra negative decades. Only applies when scale is wsp-biex. | |
| plot_population | No | the population plotted; empty for all events. | |
| compensation_method | No | which published algorithm: FlowKit's solve(Sᵀ, Xᵀ) or flowCore's X · S⁻¹. They agree to ~1e-15 of full scale. Values: flowkit (solve(Sᵀ, Xᵀ) (FlowKit)), flowcore (X · S⁻¹ (flowCore)). Only applies when compensation is auto or file. | flowkit |
Output Schema
| Name | Required | Description |
|---|---|---|
| mst | Yes | the minimum spanning tree: node pairs and normalized weights |
| seed | Yes | the seed the run consumed |
| nodes | Yes | per node: metacluster, share of events, median per map channel |
| outliers | Yes | per node: events, outliers, distance threshold, maximum distance |
| metaclusters | Yes | per metacluster: share of events |
cluster_moleculesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | MaxMin: seed of the first pick, as RDKit's seed. | |
| picks | No | MaxMin: how many structures to pick. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| method | No | the clustering method. Values: butina (Butina (sphere exclusion)), maxmin (MaxMin diversity pick), average (Average linkage (UPGMA)). | butina |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| clusters | No | average linkage: how many clusters to cut the tree into. | |
| molecules | Yes | the structures: one SMILES or molfile per entry. | |
| threshold | No | Butina: neighbors within this distance (1 − Tanimoto), 0–1. | |
| reordering | No | Butina: recount unassigned neighbors after each cluster. |
Output Schema
| Name | Required | Description |
|---|---|---|
| picks | Yes | MaxMin: input indices in pick order |
| groups | Yes | Butina and average linkage: clusters of input indices (Butina: centroid first) |
| unread | Yes | input indices RDKit could not read, left out |
| summary | Yes | the clustering in words, generated from this run |
codon_optimalityBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| host | No | one of the three codon-usage tables bundled with the app. Only applies when table is not given. | E. coli K-12 |
| table | 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 the three tables bundled with the app. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | 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. | |
| threshold | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| fop | Yes | frequency of optimal codons, 0-1 |
| report | Yes | the full readout, including which host table answered |
| scored | Yes | codons that carried a call — stops and unevidenced families are excluded from both halves |
| nonOptimal | Yes | how many codons are NOT optimal (the honest denominator beside fop) |
| optimalCodons | Yes | size of the optimal set the reference defines |
codon_table_fetchBRead-onlyInspect
Fetch a real codon-usage table for an organism and save it into this project, so later steps can score against it by name.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | which CDS set to count. `heg` uses the highly-expressed-gene set, which is what CAI and Fop reference tables are conventionally built from; `genome` counts every annotated CDS, which describes the organism's average gene rather than its best-expressed one. Values: heg (Highly-expressed genes — the CAI/Fop convention), genome (Whole genome — every annotated CDS). Only applies when source is ncbi. | heg |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| source | No | which register to build the table from. `ncbi` counts the CDS of a RefSeq assembly and covers any organism with one; `kazusa` serves a published table and covers only the organisms its mirror bundles. Values: ncbi (NCBI RefSeq — counted from annotated CDS, any organism), kazusa (Kazusa/CUTG mirror — published table, bundled organisms only). | ncbi |
| save_as | No | the name to save the table under, as `table` on the other codon tools will spell it. Defaults to the resolved organism plus the basis, which is what the panel names it. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| coverage | No | how much of a multi-replicon assembly to download. `complete` takes every replicon; `budgeted` takes the largest ones that fit a memory budget and SAYS which it used. The panel defaults to complete and falls back when the browser cannot hold the whole thing. Values: complete (Complete assembly), budgeted (Budgeted — largest replicons that fit). Only applies when source is ncbi. | complete |
| organism | Yes | the organism: a scientific name ("Saccharomyces cerevisiae") or an NCBI taxonomy id ("4932"). Resolved live against NCBI — no allow-list (§1 r4) — and the assembly it picks comes back in `report.builtFrom`. |
Output Schema
| Name | Required | Description |
|---|---|---|
| cds | Yes | how many CDS the table was counted from — the reference-set size, and the number a thin table is thin by. Absent on a register that publishes no counts |
| gc3 | Yes | GC at the third codon position (%), the usage fingerprint. NCBI only; absent elsewhere |
| table | Yes | the saved name — wire this straight into `table` on codon_usage_analysis or codon_optimality |
| codons | Yes | total codons counted, the weight behind every frequency. ABSENT when the register publishes frequencies rather than counts (the Kazusa mirror does) — never 0, which would be a number you could quote |
| report | Yes | the full provenance: register, resolved organism, the identifier the table was built from, and any coverage fallback |
| organism | Yes | the organism as the register resolved it, which may be more specific than asked |
codon_usage_analysisBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| table | 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`, and switches the rare-codon call from pydna's curated list to `rare_threshold`. Leave unset for the curated pydna report, which is the only arm carrying start/stop weights and the N-end half-life. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| feature | 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. | |
| reverse | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| organism | No | reference organism for CAI weights + rare codons. Only some organisms carry CAI weights; the rest still get the rare-codon scan + GC. | sce |
| enc_pairs | No | count codon PAIRS rather than single codons for ENC (k-mer 2) — bias in the junctions rather than in the codons. | |
| rcbs_mean | No | how the per-codon RCBS weights are averaged. Roymondal 2009 uses the geometric mean. Values: geometric (Geometric (Roymondal 2009)), arithmetic (Arithmetic). | geometric |
| rare_threshold | 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 table is set. | |
| rcbs_directional | No | RCBS weights taken as max(observed/expected, expected/observed), so under-use counts as bias too rather than only over-use. | |
| enc_bg_correction | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| gc | Yes | GC fraction (0–1) |
| cai | Yes | Codon Adaptation Index, or null when nothing could be scored — check `caiAvailable` before comparing it, and `referenceTable` before comparing two runs |
| enc | Yes | effective number of codons, 20 (one per residue) to 61 (uniform) — needs no reference table |
| rcbs | Yes | relative codon bias vs the sequence's own base composition; 0 = as predicted — needs no reference table |
| codons | Yes | number of codons |
| region | Yes | what was actually measured — the selection when there is one, otherwise the whole record, naming the STRAND and where it came from |
| report | Yes | the full codon report |
| codonMap | Yes | how often each of the 64 codons occurs in the measured region, laid out as the genetic-code chart: rows are the first two bases, columns the third |
| rareHits | Yes | every rare-codon occurrence with its position |
| rareBasis | Yes | `curated` (pydna's published low-usage list for this organism — `rare_threshold` did not apply) or `threshold` (relative adaptiveness below `rare_threshold`). Rare counts from the two are different claims and do not compare |
| caiAvailable | Yes | whether a CAI could be computed at all. FALSE means `cai` is null because there was no reference to score against, NOT that adaptation is poor |
| rareFraction | Yes | fraction of codons that are rare (0–1) |
| strandSource | Yes | `explicit` (you passed `reverse`), `feature` (taken from the annotation the selection matches) or `default` (forwards, nothing said otherwise) |
| referenceTable | Yes | the project table CAI was scored against, or empty when the curated pydna organism answered |
codon_usage_distanceBRead-onlyInspect
How this region's codon usage compares with the record's OTHER genes (CUFS, Diament, Pinter & Tuller 2014).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| feature | 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. | |
| reverse | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| synonymous | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| region | Yes | what was actually scored, naming the STRAND and where it came from — a reverse-strand gene read forwards is a wrong answer, not a missing one |
| ceiling | Yes | the largest distance this run could have produced, for the mode it ran in — read a distance against THIS, never against a constant |
| nearest | Yes | the feature whose codon usage is closest to the scored region |
| skipped | Yes | features that were NOT compared and why — a feature too short for the statistic is reported, never dropped |
| compared | Yes | how many features were compared |
| furthest | Yes | the feature whose codon usage is least like the scored region — the odd one out |
| neighbours | Yes | every other coding feature with its CUFS distance, nearest first — name, span, codons compared and distance |
| synonymous | Yes | whether amino-acid composition was normalised away — the same column of figures means a different thing under each |
| strandSource | Yes | `explicit` (you passed `reverse`), `feature` (taken from the annotation the selection matches) or `default` (forwards, nothing said otherwise) |
| nearestDistance | Yes | its distance. 0 would mean an identical codon distribution; the maximum depends on the mode and is reported as `ceiling` beside it — sqrt(2 ln 2) = 1.177 for the plain form, sqrt(2 ln 2 F) = 5.396 for the synonymous one, which normalises each amino acid separately |
compare_antibodiesARead-onlyInspect
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 point, net charge, GRAVY, ε280 and the net charge of its CDRs.
| Name | Required | Description | Default |
|---|---|---|---|
| pH | No | the pH the net charge and the CDR charge are reported at. | |
| chain | No | which variable domains to align: heavy, or light (kappa and lambda together). Values: heavy (Heavy), light (Light (kappa and lambda)). | light |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| antibodies | No | the antibody chains to compare: wire several upstream records here, or list library documents or protein sequences. | |
| definition | No | the CDR definition, numbered in its own scheme (North in Chothia's). Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), north (North). | kabat |
| include_subject | No | also compare the open record. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | one gapped row per aligned chain, `{ name, aligned }`, the shape the alignment tools read |
| chains | Yes | per chain: name, record, chain type, and its V domain's length, molecularWeight (Da), isoelectricPoint, chargeAtPH, gravy, extinction (reduced and cystines) and cdrCharge |
| refused | Yes | records that gave no chain of the class, each with its reason |
| regions | Yes | the region of each column under the definition: FR1, CDR1 … FR4 |
| alignment | Yes | the alignment as abnumber prints it: rows, identity lines, and the CDRs marked ^ (Vernier °, under Kabat) |
| identical | Yes | columns where every chain holds the same residue |
| mutations | Yes | columns holding more than one residue (a gap counts as one) |
| positions | Yes | the scheme position of each column (`82A`) |
compare_constructionsARead-onlyInspect
Align two constructs' build procedures step by step, in order — was this built the same way as that?
| Name | Required | Description | Default |
|---|---|---|---|
| key | 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, identical only when the very same step ran on the very same molecules. | abstract |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| against | Yes | File id or name of the construct to compare against, in the same project. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | No | File id or name for THIS side. The focused document when omitted. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | the whole aligned history, row by row: shared, only-here, or only-there |
| shared | Yes | steps both procedures have, in the same order |
| similarity | Yes | shared steps as a percentage of the alignment |
compare_flow_cytometry_populationsBRead-onlyInspect
One channel of an FCS file between two populations of the run (FlowJo's and FCS Express's population comparison): Welch's two-sample t-test, the Wilcoxon rank-sum test, the two-sample Kolmogorov–Smirnov test and Pearson's χ² on the two histograms over shared equal-width bins, each R's test on the populations' linear values.
| Name | Required | Description | Default |
|---|---|---|---|
| A | No | additional negative decades. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| M | No | decades of the full scale. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| T | No | top of scale; empty means the file's largest fluorescence $PnR. | |
| W | No | linear width in decades. Only applies when scale is logicle or hyperlog or flowcore-logicle. | |
| scale | No | the display scale of the fluorescence channels (scatter and time stay linear): used for the plot, the threshold and, with `stats_on: scaled`, the statistics. Values: logicle (Logicle (Gating-ML 2.0, Moore & Parks)), fasinh (ArcSinh (Gating-ML 2.0 fasinh)), arcsinh (ArcSinh with a cofactor (asinh(x / c), Cytobank and CyTOF)), hyperlog (Hyperlog (Gating-ML 2.0, Bagwell)), flowcore-logicle (Logicle on a 0–M axis (flowCore)), wsp-biex (Biex (FlowJo 10, channels 0–4096)), flin (Linear (Gating-ML flin)). | logicle |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| gating | No | a Gating-ML 2.0 document in the project, by name or id; empty for no gating (every statistic is then of all events). | |
| plot_x | No | channel (PnN or PnS) on the density plot's x axis; empty for no plot. | |
| plot_y | No | channel on the plot's y axis. | |
| derived | No | derived parameters, `name = expression` separated by `;` (FlowJo's vocabulary: channels by name or [name], + − * / % ^, abs ceil floor neg round max min pow exp ln log sqrt and the trig functions); each becomes a channel of the run. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cofactor | No | the c in asinh(x / c): 5 is the CyTOF convention, 150 a common one for fluorescence. Only applies when scale is arcsinh. | |
| document | No | the FCS file, by name or id; may be left empty when the project holds exactly one. | |
| biex_width | No | FlowJo biex width basis (negative; FlowJo's default -10). Only applies when scale is wsp-biex. | |
| compare_bins | No | equal-width histogram bins over both populations’ range, for the χ² test. | |
| compensation | No | `auto`: the file's own $SPILLOVER/$SPILL when it has one, else none; `file`: that, refusing a file without one; `none`: leave the values as acquired. Values: auto (automatic), file (file's own matrix), none (none). | auto |
| population_a | No | population A; empty for all events. | |
| population_b | No | population B; empty for all events. | |
| biex_negative | No | FlowJo biex extra negative decades. Only applies when scale is wsp-biex. | |
| compare_channel | No | the channel compared (PnN, PnS or a derived name); empty for the first fluorescence channel. | |
| plot_population | No | the population plotted; empty for all events. | |
| compensation_method | No | which published algorithm: FlowKit's solve(Sᵀ, Xᵀ) or flowCore's X · S⁻¹. They agree to ~1e-15 of full scale. Values: flowkit (solve(Sᵀ, Xᵀ) (FlowKit)), flowcore (X · S⁻¹ (flowCore)). Only applies when compensation is auto or file. | flowkit |
Output Schema
| Name | Required | Description |
|---|---|---|
| ks_d | Yes | Kolmogorov–Smirnov D |
| tests | Yes | every test: method, statistic, parameter, p-value; the χ² histograms |
| welch_p | Yes | Welch's t-test p-value |
| rank_sum_p | Yes | Wilcoxon rank-sum p-value |
compare_moleculesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| other | Yes | the structure to compare it with: SMILES or a molfile. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| molecule | Yes | the query structure: SMILES or a molfile. | |
| tversky_a | No | Tversky's weight on bits only the query has, 0–1. | |
| tversky_b | No | Tversky's weight on bits only the other has, 0–1. | |
| fingerprint | 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). | morgan |
Output Schema
| Name | Required | Description |
|---|---|---|
| metrics | Yes | every metric on the chosen fingerprint, keyed Tanimoto, Dice, Cosine, Sokal, Russel, RogotGoldberg, AllBit, Kulczynski, McConnaughey, Asymmetric, BraunBlanquet, OnBit, Tversky |
| summary | Yes | the comparison in words, generated from this run |
| count_similarity | Yes | Tanimoto, Dice and Tversky on unfolded Morgan radius-2 counts |
| tanimoto_by_fingerprint | Yes | per fingerprint: kind, length, bits set in each molecule, bits in common, Tanimoto |
compare_reads_to_referenceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| reads | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| end_phred | 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 ends are trimmed by RUN rather than per base. Only applies when quality_filter is true. | |
| min_phred | No | mask any single base below this phred score. Only applies when quality_filter is true. | |
| genetic_code | No | NCBI genetic-code table id, used to say what a variant does to the protein of a CDS on the reference. Advanced. | |
| quality_filter | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| gaps | Yes | stretches of the reference no read covers, as 1-based inclusive runs. A clean comparison over 60% of a construct is not a verified construct, and this is the half that says so |
| record | Yes | the consensus as a linear record, ready for any downstream step |
| perRead | Yes | each read's own coverage, identity and substitution / deletion / insertion counts, plus how often it disagrees with the accepted consensus — the row that says WHICH read is the problem |
| accepted | Yes | how many of those the vote accepted — every covering read agreed |
| cautions | Yes | every caution this comparison raises, each naming its own subject: uncovered stretches, reads that reach across only part of the frame, reads that dissent from the accepted consensus, insertions the reads could not resolve, mixed peaks |
| variants | Yes | one row per column where a read differs from the reference: its position, the reference base, the voted base, whether the vote ACCEPTED it, the coverage behind it and the consequence for the protein |
| consensus | Yes | the voted consensus as a sequence, gaps and unresolved insertions removed — the sequence to hand on |
| conclusion | Yes | the run's headline in one sentence, generated from THIS result and identical to the words the panel shows |
| derivation | Yes | the chain behind the numbers: what identity was measured over (and that an indel does not lower it), the unanimity rule, how one frame came out of N pairwise alignments, the quality gate, the genetic code and the inputs |
| coveragePct | Yes | how much of the reference any read covers at all |
| identityPct | Yes | of the covered columns, how many match the reference |
| alignmentFigure | Yes | the reference and every read in the shared frame, 80 columns around the first ACCEPTED change (else the first difference, else the start), shaded by column identity; draw_alignment draws any other window of `alignedReads` |
compare_treesARead-onlyInspect
Compare trees over the same taxa: the Robinson-Foulds distance between two of them, and the consensus of any number.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | 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). | majority |
| trees | Yes | two or more trees in Newick (NEXUS, PhyloXML and NeXML pastes are sniffed too) — wire `newick` outputs here. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| cutoff | No | the fraction of trees a clade must appear in for a majority consensus. Only applies when mode is majority. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sharedTaxaOnly | 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 is a lower bound on the disagreement between the trees as given. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rf | Yes | Robinson-Foulds distance between the first two trees (absent for one tree) |
| consensus | Yes | the consensus tree, in Newick |
| distances | Yes | every distance the comparison computes, not just RF |
| treeCount | Yes | how many trees went into the consensus |
| normalized | Yes | the same distance as a fraction of its maximum, 0 = identical topology, 1 = share nothing |
| prunedTaxa | Yes | under `sharedTaxaOnly`: the labels dropped from each tree, so a comparison over a smaller set can never be read as one over the whole |
| comparedTaxa | Yes | how many taxa the distances were computed over — under `sharedTaxaOnly` this is the shared set, which is smaller than either tree |
consensus_from_tracesBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | No | the first read: its name or its project file id. | |
| min_conf | No | the confidence a base must clear to be called rather than written as a code. SeqTrace range 1-61. | |
| algorithm | 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 settings of one. | Bayesian |
| trim_window | 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. | |
| primer_match | 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. | |
| quality_trim | 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_primers | No | cut the primers off the consensus ends. It runs INSIDE the quality-trim stage, so turning it on turns that stage on too. | |
| trim_end_gaps | 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_min_good | 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. | |
| forward_primer | No | the forward primer to cut, 5→3. Only applies when trim_primers is true. | |
| reverse_primer | No | the reverse primer to cut, 5→3. Only applies when trim_primers is true. | |
| second_document | 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 | No | reverse-complement the second read before merging. A reverse read of the same amplicon needs this; two forward reads do not. |
Output Schema
| Name | Required | Description |
|---|---|---|
| length | Yes | its length in bases |
| reading | Yes | the same sentence the editor shows for this run, generated from it |
| consensus | Yes | the consensus, compact (no spacers) — what you would export or align |
| readsUsed | Yes | how many reads went in. With 1, an ambiguity is low confidence; with 2, it is disagreement |
| trimmedFromEnds | Yes | positions the consensus's own trimming stage removed |
| ambiguousPositions | Yes | positions written as an IUPAC code. Wire it into a gate — but read `readsUsed` first, because the number means two different things |
convert_mass_molesARead-onlyInspect
Convert a mass of a molecule to an amount in moles and a number of molecules, or an amount back to a mass.
| Name | Required | Description | Default |
|---|---|---|---|
| mass | No | the mass to convert. Leave it or `amount` empty: the empty one is calculated. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| amount | No | the amount in moles to convert. Leave it or `mass` empty. | |
| strands | 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), double (Both strands), single (One strand). Only applies when molecular_weight is not given. | record |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| mass_unit | No | the unit of the mass, given or solved. | ng |
| amount_unit | No | the unit of the amount, given or solved. | pmol |
| molecular_weight | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| mass | Yes | the mass, in its unit |
| amount | Yes | the amount in moles, in its unit |
| copies | Yes | number of molecules |
| molecularWeight | Yes | the weight used |
copy_number_allele_splitARead-onlyInspect
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 instability).
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| estimated_only | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| metrics | Yes | ASCAT 3.2.0's ascat.metrics() profile columns over the estimated segments, unrounded: n_segs, segs_size, size_odd_segments, size_intermediate_segments, homdel_segs, homdel_largest, homdel_size, homdel_fraction, LOH (autosomal fraction), mode_minA, mode_majA, WGD (0, 1, '1+' or null) and GI (null when WGD is). Null when nothing is estimated |
| summary | Yes | how many segments carry a split, how many are LOH (and copy-neutral), homozygous deletions, imbalanced and balanced, and the autosomal LOH fraction |
| segments | Yes | one entry per segment: chromosome (the file's own name, X not 24), start and end (the file's coordinates), markers, estimated, major and minor (null where not estimated), raw_a and raw_b (the producer's raw nA/nB, null where empty), total_cn (the producer's total, fractional where it made no integer call), state (not-estimated, homozygous-deletion, loh, balanced, imbalanced) and relative_to_ploidy (below, equal, above, for LOH only, null when no ploidy is stated) |
| provenance | Yes | which file answered, the data set the split was read from, how many segments it holds and how many are estimated, and the producer's own fit: ploidy and aberrant-cell fraction as the chip summary states them |
copy_number_compareARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| compare | 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 answers one question twice. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| data_set | 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. | |
| min_bases | 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. | |
| min_markers | 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 the same floor copy_number_findings applies. | |
| compare_data_set | No | which data set of the second file to scan. Unset is that file's FIRST. |
Output Schema
| Name | Required | Description |
|---|---|---|
| shared | Yes | one entry per PAIR of overlapping calls of the same kind: chrom (the name BOTH files resolved to, never either file's raw chromosome number), kind, a and b (the two calls, each with its own start, end, marker count and value), overlapBases, and reciprocalOverlap — the SMALLER of the two containment fractions, so a focal call inside a whole-arm one scores low rather than 100%. A call that overlaps several on the other side appears once per pair, which is how the reference application's own overlap table behaves |
| summary | Yes | how many of each sample's own calls are shared and in how many overlapping pairs (a call can overlap several on the other side, so the two differ), how many each carries alone, over how many chromosomes both files index, and which floors were applied |
| compared | Yes | the chromosome names both files index — what this comparison actually covers, so a caller can tell a clean result from a narrow one |
| provenance | Yes | which two files and data sets answered, how each side’s calls were read (the producer’s own segment calls, or the per-marker state columns), how many calls each side contributed, and the floors applied to both |
| only_in_file | Yes | the first sample’s calls that no call of the same kind in the second sample overlaps, on a chromosome BOTH files index — each with the chromosome name and the call itself. This is the half a reader cannot get by reading two result sets one after the other |
| only_in_compare | Yes | the second sample’s calls that no call of the same kind in the first sample overlaps, on a chromosome both files index |
| unmatched_chromosomes | Yes | chromosomes only one of the two files indexes, each with which side carries it. Their calls were NOT compared and are NOT in only_in_file or only_in_compare: a targeted array that does not carry Y says nothing about Y in the other sample |
copy_number_findingsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| data_set | No | which data set to scan, by name. Unset is the file's FIRST, which is what the panel opens on. | |
| min_bases | 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. | |
| min_markers | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| bed | Yes | the same calls as a UCSC BED track, ready for IGV, the UCSC browser or bedtools: 0-based half-open, one row per finding, colored by kind through itemRgb, with the producer's confidence in the score column (0 where the file states none) and the genome build on the `track db=` line when the container names one. The JSON `findings` above carry the file's own inclusive marker positions; this output is the same calls converted once, by the same writer the Export panel uses |
| source | Yes | which route answered: `segments` means the producer's own segment calls, which is what a CYCHP written by ChAS carries; `markers` means the per-marker state columns, which is what a CNCHP carries. Different provenance for the same question, so a pipeline comparing two files can tell which it got |
| summary | Yes | what was found, across how many chromosomes and markers |
| findings | Yes | every gain, loss and stretch of homozygosity, as the file called them: kind, chromosome, startPosition, endPosition, markerCount, bases, and — where the file states them — state and stateLabel (the copy-number state; absent on an LOH finding, which is not a copy-number call), confidence (the producer's own, 0..1) and mixture (mosaic fraction, signed as the file signs it, so a mosaic loss and a mosaic gain stay distinguishable). No cytoband: naming a band needs a genome build, and this node is given none |
| chromosomes | Yes | per chromosome: markers read, and the counts and spans of gains, losses and LOH runs |
copy_number_lohARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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 | 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 against another caller. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| error_rate | 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 genotype confidences reach the no-call threshold, and the output says which value was actually used. | |
| min_genomic_span | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| runs | Yes | one entry per called run: chromosome (the file's own label), start, end, markers (how many genotyped markers it spans). Coordinates are the marker positions the container states, on whatever assembly it names |
| window | Yes | what the parameters solved to for THIS sample: markerCount (the window width), hetCutoff (heterozygotes at or above which the window is not LOH), and errorRate (the value used, which differs from the parameter when it was re-estimated from the no-call rate) |
| summary | Yes | how many runs of loss of heterozygosity were called, over how many chromosomes and how many megabases, and how many markers the method could read |
| accounting | Yes | markers (genotype calls read), noCalls (dropped before anything else), evaluated, inSegmentsTooShort (markers in a stretch shorter than the window, left UNCALLED rather than called clear), beyondLastChromosome, segments. The five ways a marker can be spent sum to markers |
| provenance | Yes | which data set the genotype calls came from, which one the coordinates came from, how many were paired, and the parameters in force. The pairing is checked against the marker each call names, never trusted |
copy_number_mosaicismBRead-onlyInspect
Estimate which mosaic fraction class each region of one chromosome is closest to, as Affymetrix Power Tools computes it.
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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. | |
| graph | 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 column is already someone's answer. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| data_set | No | which data set to read, by name. Unset is the file's FIRST, which is what the panel opens on. | |
| chromosome | 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 count it has and the ones that would run. | |
| mosaic_bandwidth | 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 | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| called | Yes | the subset of segments with call === 1 — the mosaic events themselves, separated out so a pipeline does not have to know the vendor’s clonal test to find them |
| summary | Yes | how many segments the method produced, how many of them it CALLED as mosaic, which classes they fall in, and which chromosome and column answered |
| segments | Yes | every segment: startPosition and endPosition in bases, startIndex and endIndex in markers, mixture (the class as APT numbers it), mixtureValue (the fraction that class is NAMED for — a label, not a measurement), confidence, and call, which is 1 only for a segment the method calls mosaic. A reader looking for mosaic events wants call === 1 |
| provenance | Yes | which file, data set, chromosome and column answered, how many markers were read, the windows and the eight class boundaries the run used, and the sentence this estimate must be presented with — verbatim from the engine, never paraphrased |
copy_number_readBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| end | 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 Region field does. | |
| bins | 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. | |
| file | 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. | |
| start | 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 assembly and an array's coverage stops where it stops. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| compare | 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 LABEL and not by number, because each file states its own numbering, and its graphs are matched by COLUMN NAME, so a file carrying a different set of them reports which it has rather than answering from whatever sits at that position. Unset, nothing of a second file is read. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| data_set | No | which data set to read, by name. Unset is the file's FIRST, which is what the panel opens on. | |
| chromosome | 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 arrays give as 24 and 25) and read from it rather than assumed. Unset is the first the index carries, which is what the panel selects. |
Output Schema
| Name | Required | Description |
|---|---|---|
| lanes | Yes | the tracks above drawn as the canvas draws them: one lane per graph over the same window, the bucket min-max envelope with its mean over it, the compared sample's envelope behind it where `compare` named a second file, and the marker lane underneath, because a gap in the probes is not a deletion. Null when no graph was decimated — no chromosome was selected, or none of its markers carried a value |
| tracks | Yes | the selected chromosome decimated: per graph, its fitted range, the bucket minima/maxima/means, and how many markers carried no value |
| summary | Yes | the file in one sentence, generated from this run — the panel's own facts |
| compared | Yes | null unless `compare` named a second file. Otherwise: file, dataSet, chromosomeLabel and chromosomeInThatFile (matched by LABEL, so the number may differ), markersOnChromosome and markersInWindow (ITS markers — a different array covers a chromosome at a different density), bins and binnedOver (the SAME buckets and the same extent as `tracks`, which is what makes the two comparable at a coordinate), and tracks: one entry per graph of the PRIMARY file, each with that graph's buckets in the compared sample, or `absent` naming the column the compared file does not carry. A `refused` field instead of the rest means the comparison could not be made and says why — never an empty list, which would read as the two samples agreeing |
| data_sets | Yes | every data set, with its row count, its columns and which of them are graphs |
| provenance | Yes | the header chain the file states about itself: algorithm, version, array, and the annotation release it was analyzed against |
| chromosomes | Yes | the file's OWN per-chromosome index — start row, marker count and display flag each. This is what makes a chromosome one ranged read rather than a whole-file scan. A CNCHP states it in the data set's parameters and a CYCHP as rows in Chromosomes/Summary; both are read, and `index_source` says which one answered |
| index_source | Yes | where the per-chromosome index above came from, because the two container shapes keep it in different places and a reader comparing two files should not have to guess which |
copy_number_regionsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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. | |
| build | 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 coordinates, and placing a call on the wrong assembly moves every boundary by hundreds of kilobases with nothing to show it. Values: hg19 (hg19 / GRCh37), hg38 (hg38 / GRCh38). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| regions | 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 states no dosage score, so with this set every hit comes back with dosage null: the list says where to look and claims nothing about what a change there means. If the file states an assembly on its track line (`track ... db=hg19`) and it is not the build being read, the node refuses rather than moving every boundary by hundreds of kilobases. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| data_set | No | which data set to scan, by name. Unset is the file's FIRST, which is what the panel opens on. | |
| min_bases | 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. | |
| min_markers | 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_number_findings applies, so both doors place the same calls. |
Output Schema
| Name | Required | Description |
|---|---|---|
| regions | Yes | one entry per curated region containing at least one call: id (the ISCA identifier a report cites), name, cytoband, chrom, start, end (0-based half-open), covered (fraction of the region the calls cover between them, each base counted once, so it never exceeds 1), counts by finding kind, and hits — each with the finding itself, overlapBases, reciprocalOverlap (the SMALLER of the two containment fractions, so a focal call inside a whole-arm region scores low rather than 100%), regionCovered, and dosage/dosageAxis: ClinGen's score and description for the axis that speaks to that call's direction, or null for LOH and mosaic events, which change no copy number |
| summary | Yes | how many curated regions contain a call, out of how many were checked, on which build |
| unplaced | Yes | curated regions ClinGen has NOT placed on this build — it states their location as 'tbd'. They carry id, name, cytoband and their dosage scores but no coordinates, so nothing could be checked against them. They are NOT clean: they are unchecked. Empty on hg19, which places all of them |
| provenance | Yes | which region list answered: its authority, source URL, the curation date the file states, the assembly, and how many regions were placed and unplaced. A cached copy of an authority's table is only interpretable with its version beside it |
copy_number_segmentBRead-onlyInspect
Segment one chromosome of an Affymetrix copy-number container by up to four independent methods and report where they agree.
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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. | |
| graph | 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 already someone's answer. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| cbs_eta | 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 the panel. | |
| methods | 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 here is not a different default — it is the same control, pressed. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cbs_seed | 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_trim | 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 sdundo. | |
| data_set | No | which data set to segment, by name. Unset is the file's FIRST, which is what the panel opens on. | |
| pcf_kmin | No | PCF's shortest allowed segment, in markers — the finest change the fit may claim. Same default as the panel. | |
| hmm_model | 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 APT's generic method with its GC-corrected means, `apt-cn-cyto2` the six-state method written for CytoScan arrays. The panel lists the same models in the same order. Values: file (This file’s own parameters), apt-cn-state (APT cn-state (GC-corrected)), apt-cn-cyto2 (APT cn-cyto2 (CytoScan)). | |
| pcf_gamma | 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 array and a noisy one. Same default as the panel. | |
| chromosome | 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. | |
| pcf_method | 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 against R, so this is a real choice. `exact` is refused above 25,000 markers rather than silently downgraded: it is quadratic there (21 s at 100,000), where the approximation fits a whole 142,000-marker chromosome in about 0.3 s. Same default as the panel. Values: auto (Automatic), exact (Exact), fast (Approximate). | auto |
| cbs_undo_sd | 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. | |
| pelt_penalty | 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 constant calibrated against this array's noise. MBIC is changepoint's own default and adds log(segment length) to each segment's cost as well as its (parameters + 2)·log(n) penalty. `Manual` is the only one that reads `pelt_penalty_value`. Same default as the panel. Values: MBIC (MBIC), BIC (BIC), SIC0 (BIC without the location term), AIC (AIC), Hannan-Quinn (Hannan-Quinn), Manual (Manual), None (None). | MBIC |
| pcf_normalize | 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. Same default as the panel. | |
| cbs_undo_prune | 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. | |
| pelt_minseglen | No | PELT's shortest allowed segment, in markers (changepoint's `minseglen`) — the finest change the fit may claim. Same default as the panel. | |
| cbs_undo_splits | 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 boundary bigger than the noise?), `prune` keeps the fewest change points whose cost stays within `cbs_undo_prune` (how few boundaries explain this almost as well?). Same default as the panel. Values: none (Keep every split), sdundo (Merge within SDs), prune (Prune by cost). | none |
| pelt_standardize | 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 change-in-mean cost is a raw residual sum of squares while the penalty is on a log(n) scale, so the two are only commensurate at unit variance. Off, a noisy array buys boundaries it should not and a quiet one buys none, and both look like plausible answers. Same default as the panel. | |
| pelt_penalty_value | 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 the panel. Only applies when pelt_penalty is Manual. |
Output Schema
| Name | Required | Description |
|---|---|---|
| summary | Yes | what each method answered on this chromosome, generated from the run — never a fixed sentence over a variable outcome |
| segments | Yes | per method, its segments with their marker range, genomic span and level — and for the HMM, the state it called |
| agreement | Yes | where the methods that ran put their boundaries, and which boundaries more than one of them found. This is the reading no single method can produce |
| derivation | Yes | per method, what it actually used: the model and its means for the HMM, the seed for CBS, kmin and the raw and scaled gamma for PCF — plus each method's published provenance, and the reason where one declined to run |
copy_number_somaticARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| detected_only | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| calls | Yes | one entry per mutation probe set: probe_set (the producer's own identifier), call (its word — `Detected`, `Undetected`, or a third this reader passes through unchanged), detected (that word tested against the undetected one), score (MutScore, the statistic the call was made on), signal (QNSignal, the quantile-normalized signal behind the score), threshold_high and threshold_low (MutThreshHigh/MutThreshLow — the bars THIS probe set was graded at, which differ row to row), and from the array's annotation database for the genome the file states: gene, mutation (protein and cDNA change), cosmic (COSMIC id), chromosome, and position (1-based, the variant's first base); all five are null for a probe set that database does not list or when the file states no genome it is cached for. |
| summary | Yes | how many mutation probe sets this file states, how many the producer detected, and which array wrote them |
| detected | Yes | the subset of `calls` whose word is not the undetected one — the mutations this sample actually carries, in the same shape |
| provenance | Yes | which file answered, the container kind it was read from, the name of the data set the somatic table was found in, how many rows it holds, placement (which annotation database, genome and retrieval date placed the calls and how many it placed, or why none were placed), and the vocabulary note: the call words are the producer's own and are not normalized here |
crispr_analyze_screenARead-onlyInspect
Call HITS from a pooled CRISPR screen: per-guide read counts in, a gene-level Bayes factor and a precision/recall curve out.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| fdr_cut | 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 | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| min_reads | No | drop a reagent whose SUMMED control count is below this (upstream's -m). Applied after the pseudocount, exactly as upstream applies it. | |
| read_counts | 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 are. | |
| pseudo_count | No | added to every count before normalising to 10,000,000 reads per column. Advanced. | |
| sample_columns | No | which sample column names to score. Leave empty to score every column that is not a control. | |
| control_columns | 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. | |
| essential_genes | 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. | |
| equalise_replicates | 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 until this is set. Advanced. | |
| non_essential_genes | Yes | reference NON-ESSENTIAL gene symbols, one per line. BAGEL2's NEGv1 is the usual choice. |
Output Schema
| Name | Required | Description |
|---|---|---|
| fit | Yes | the fitted line the Bayes factor is scored against: slope, intercept and the fold-change window |
| hits | Yes | genes at or above the Bayes factor the FDR cut lands on |
| curve | Yes | the precision/recall curve, one row per gene |
| genes | Yes | every gene with its Bayes factor, standard deviation and observation count, ranked |
| hitBf | Yes | the Bayes factor the cut lands on (0 when nothing clears the FDR) |
| training | Yes | reference essential and non-essential genes FOUND in this library, against the number supplied — the check that the symbols match |
crispr_design_guidesBRead-onlyInspect
Design and score CRISPR guides on the subject — on/off-target scores, QC flags, and cloning-enzyme conflicts.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| min_stem | No | minimum self-complementary stem to report. In nt. Advanced. | |
| nuclease | 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: NNGRRT (3')), SaCas9-KKH (SaCas9-KKH: NNNRRT (3')), AsCas12a (AsCas12a: TTTV (5')), LbCas12a (LbCas12a: TTTV (5')), enAsCas12a (enAsCas12a: TTTV (5')). | SpCas9 |
| region_end | No | restrict results to guides ending at/before this position. In bp. Advanced. | |
| region_start | No | restrict results to guides starting at/after this position (0-based). In bp. Advanced. | |
| restriction_enzymes | No | cloning enzymes whose recognition site must NOT appear in the spacer. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | guides passing the region filter |
| guides | Yes | the designed guides, scored |
| region | Yes | the window the guides were filtered to, resolved: start, end, and whether it is the whole molecule. Reported because `region_start`/`region_end` are optional and their default is the molecule's length, which a caller holding only this result does not have — without it, `count` of `totalCandidates` cannot be read |
| topSpacer | Yes | spacer of the highest-ranked guide |
| totalCandidates | Yes | candidates found before filtering |
crispr_design_libraryARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| moi | 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. | |
| rank | 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 editor fetches on demand, and this engine is headless and cannot fetch — offering it would return an unranked pool that looked ranked. | ruleSet1 |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| nuclease | 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: NNGRRT (3')), SaCas9-KKH (SaCas9-KKH: NNNRRT (3')), AsCas12a (AsCas12a: TTTV (5')), LbCas12a (LbCas12a: TTTV (5')), enAsCas12a (enAsCas12a: TTTV (5')). | SpCas9 |
| barcode_id | No | CRISPOR subpool barcode id, 0 for none — lets several sub-libraries share one synthesis array and amplify apart. Advanced. | |
| target_type | 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 pool over one locus wants. | |
| exclude_graf | No | drop guides matching a Graf 2019 inactive motif (the TT/GCC classes). | |
| custom_prefix | 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 | No | your vector's 3' cloning overhang. Advanced. | |
| exclude_poly_t | No | drop guides whose spacer carries a Pol-III (TTTT) terminator. | |
| representation | 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. Advanced. | |
| reads_per_oligo | 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. | |
| guides_per_target | No | how many guides to take per target, best-ranked first. | |
| restriction_enzymes | No | cloning enzymes whose recognition site must NOT appear in the spacer — a hit drops the guide from the pool. Advanced. | |
| transduction_efficiency | No | fraction of cells that take up a construct, 0-1 — sizes the transduction back up from the cells you need to keep. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | oligos in the pool |
| oligos | Yes | one row per selected guide: target, spacer, coordinates, rank score, Graf class and the oligo to order |
| coverage | Yes | the screen's scale at the numbers given: cells to keep, cells to transduce, reads to buy, guides the depth expects to miss, and `belowGuidance` naming which of Joung et al. 2017's figures the plan falls short of |
| perTarget | Yes | per target: candidates, selected, shortfall, and what each filter held back |
| oligoLength | Yes | length of every oligo, for a synthesis quote (null when the pool is mixed) |
| distinctSpacers | Yes | distinct spacers — the number the screen's complexity is set by |
crispr_quantify_editsBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| donor | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| edited | Yes | the EDITED trace, by file name or id. | |
| guides | 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. | |
| control | Yes | the UNEDITED trace, by file name or id — it supplies the reference the edited read is decomposed against. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| base_editing | 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. Advanced. | |
| indel_max_size | No | largest single-cut indel modeled either side of the cut — ICE's own CLI default is 20. In bp. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| iceD | Yes | ICE-D, an independent discordance-based read on the same trace — a second opinion rather than a restatement |
| checks | Yes | TIDE once per guide and tracy's breakpoint call on the same pair, reported beside ICE and never averaged into it; tracy's `status` says whether it agrees with ICE's top sizes |
| hdrPct | Yes | the HDR percentage, when a `donor` was given |
| report | Yes | the whole result, including ICE's own notes and warnings |
| iceScore | Yes | the headline ICE score: the edited fraction of the population, 0-100 |
| perGuide | Yes | each guide's own answer: its cut (control base, from 1), the share edited there, its indel spectrum at that cut alone, and the alleles edited at it and another cut |
| rSquared | Yes | how well the fitted mixture explains the edited trace. A high ICE score with a poor fit is not a result, and this is the number that says so |
| spectrum | Yes | the indel-size histogram ICE publishes, every size from -2x to +1x `indel_max_size` INCLUDING the zeros, so the spectrum's shape is visible and not only its peaks |
| baseEdits | Yes | with `base_editing`, each fitted substitution (protospacer position, control base, change, share, refit interval), the range of the pool carrying any, and the notes on phasing and near-cut calls; null otherwise |
| inseparable | Yes | groups of reported alleles this trace cannot tell apart (their expected traces correlate above a variance inflation factor of 5), each with its summed share and 95% interval; the split inside a group is not measured |
| contributions | Yes | each proposed edit with its relative abundance, most abundant first |
| knockoutScore | Yes | the fraction carrying a frameshift or a 21+ bp indel — the number a knockout experiment is actually asking for, which is NOT the same as the edit fraction |
crispr_score_deephfBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| model | 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 two models are not comparable. Values: wt_u6 (WT SpCas9 · U6 promoter), wt_t7 (WT SpCas9 · T7 promoter), wt (WT SpCas9 · both promoters), esp (eSpCas9(1.1)), hf (SpCas9-HF1). | wt_u6 |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| protospacers | 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 trimmed or extrapolated. |
Output Schema
| Name | Required | Description |
|---|---|---|
| best | Yes | the highest-scoring protospacer, or empty when none could be scored |
| model | Yes | which model produced these numbers. Scores from two models are not comparable |
| scored | Yes | how many of the inputs DeepHF is defined on — the accounting, not an assumption |
| scores | Yes | every protospacer with its efficiency, IN THE ORDER GIVEN — null where DeepHF is not defined, with the reason beside it |
| efficiencies | Yes | just the numbers, same order — null-preserving, so it lines up with the input |
crispr_score_deepspcas9ARead-onlyInspect
Score CRISPR guides with DeepSpCas9 (Kim et al. 2019, Sci Adv 5:eaax9249): a predicted INDEL FREQUENCY IN PERCENT for wild-type SpCas9.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| contexts | 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 the reason beside it, rather than being trimmed or padded. |
Output Schema
| Name | Required | Description |
|---|---|---|
| best | Yes | the highest-scoring context, or empty when none could be scored |
| scored | Yes | how many of the inputs DeepSpCas9 is defined on — the accounting, not an assumption |
| scores | Yes | every context with its predicted indel percentage, IN THE ORDER GIVEN — null where the model is not defined, with the reason beside it |
| indelPercents | Yes | just the numbers, same order — null-preserving, so it lines up with the input |
decompose_r_groupsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| core | Yes | the core, as SMARTS. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| molecules | Yes | the structures: one SMILES or molfile per entry. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | per matched structure: its index and its groups (Core, R1, R2 …) as SMILES |
| summary | Yes | the decomposition in words, generated from this run |
| unmatched | Yes | input indices the core does not match |
delta_blast_smartARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| evalue | No | report alignments with E at most this (`-evalue`); BLAST's default is 10. | |
| source | 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. | bundled |
| protein | Yes | the protein, one-letter codes; wire it from translate_sequence or read it off a CDS. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| subjects | No | the proteins to search, as FASTA; leave empty to search the open record's coding sequences. | |
| threshold | No | lowest profile word score seeded in the lookup table (`-threshold`). Advanced. | |
| max_target_seqs | No | most proteins reported (`-max_target_seqs`). | |
| domain_inclusion_evalue | No | conserved-domain hits with E below this build the profile (`-domain_inclusion_ethresh`). |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | proteins reported |
| domains | Yes | the conserved-domain alignments DELTA-BLAST built its profile from (rpsblast at the domain inclusion E-value): accession, shortName, title, and each HSP's query and model coordinates, score, bits, E-value, identities and aligned strings |
| profile | Yes | how the profile was built: domainsUsed, columnsCovered, meanObservations, and the profile's gapped lambda and kappa |
| proteins | Yes | every protein hit, best first: id, title, length, and each HSP with query and subject coordinates, score, bits, E-value, identities, positives, gaps and aligned strings |
demultiplex_readsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| reads | Yes | the observed index reads to assign. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| metric | No | must match the error model the set was designed under. Values: hamming (Hamming (substitutions)), seqlev (Sequence-Levenshtein (indels)), levenshtein (Levenshtein). | seqlev |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| barcodes | Yes | the index set the reads were tagged with. |
Output Schema
| Name | Required | Description |
|---|---|---|
| hits | Yes | each read with the barcode it was assigned to and the distance |
| assigned | Yes | reads assigned within the guaranteed correction radius |
| ambiguous | Yes | reads whose nearest barcode is further than the set can correct — these are NOT that sample |
describe_discovery_corpusBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequences | No | the corpus: library document or file names, or wired records. |
Output Schema
| Name | Required | Description |
|---|---|---|
| files | Yes | every file with its record count and total length |
| records | Yes | every record: name, file, length, GC fraction |
describe_projectCRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| title | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| text | Yes | the project section exactly as the copilot receives it, one line per fact |
| files | Yes | how many files it describes |
| unread | Yes | files sent with the call that the importer could not read, each with its reason. They are not in the project, exactly as a file the app refuses at import is not |
describe_toolsARead-onlyInspect
The full description of each named tool: what it computes, its models and options, and what it refuses. The listing on this endpoint carries only each description’s opening.
| Name | Required | Description | Default |
|---|---|---|---|
| names | Yes | tool names, as `tools/list` gives them |
design_barcodesBInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | PRNG seed for a stochastic search: the same seed always gives the same set. Only applies when heuristic is sampling or ashlock. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| length | No | barcode length in bases. In bp. | |
| metric | No | error model. A set correcting one substitution may correct zero indels, so this choice is the design, not a display option. Values: hamming (Hamming (substitutions)), seqlev (Sequence-Levenshtein (indels)), levenshtein (Levenshtein), phaseshift (Phaseshift). | seqlev |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| filter_gc | No | keep only balanced-GC barcodes (suppressed for length ≤ 3). Advanced. | |
| heuristic | No | set-construction strategy. Values: conway (Conway (greedy)), clique (Clique), sampling (Sampling), ashlock (Ashlock). | conway |
| iterations | 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 | No | chromosomes carried per Ashlock generation; DNABarcodes' default. Only applies when heuristic is ashlock. | |
| min_distance | No | required minimum distance between any two barcodes — this is what buys the error correction. | |
| filter_triplets | No | reject barcodes containing a homotriplet (AAA…). Advanced. | |
| filter_self_complementary | No | reject barcodes that are their own reverse complement. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many barcodes the search actually found |
| analysis | Yes | the set's properties under EVERY metric, not just the design one |
| barcodes | Yes | the designed set |
| warnings | Yes | what the search had to say |
| guarantee | Yes | correctable / detectable errors under the design metric |
design_bisulfite_primersBInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| assay | 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-specific PCR: primers cover CpG sites so amplification ITSELF is the readout. They answer different questions and are not interchangeable. Values: BSP (BSP - amplify regardless of methylation), MSP (MSP - amplify only one state). | BSP |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| max_gc | No | highest acceptable GC. In %. Advanced. | |
| max_tm | No | primers above this Tm are rejected outright. In °C. Advanced. | |
| min_gc | 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. | |
| min_tm | No | primers below this Tm are rejected outright. In °C. Advanced. | |
| opt_tm | 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. | |
| min_cpg | No | MSP ONLY. The fewest CpG sites a primer must cover, so it can discriminate methylated from unmethylated at all. In sites. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| criteria | 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-Garden & Frommer (cpgplot)), takaiJones (Takai & Jones 2002 (promoter islands)). | cpgplot |
| max_length | No | longest primer considered. In nt. Advanced. | |
| min_length | No | shortest primer considered. In nt. Advanced. | |
| opt_length | No | primer length the ranking prefers. In nt. | |
| region_end | No | 0-based inclusive end. Unset = the whole sequence. Advanced. | |
| max_results | No | how many primer pairs to return, best first. | |
| product_max | No | longest acceptable amplicon. In bp. | |
| product_min | No | shortest acceptable amplicon. In bp. | |
| region_start | 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. | |
| island_window | No | sliding window over which C, G and CpG are counted (cpgplot -window); unset takes the preset's. In bp. Advanced. | |
| min_non_cpg_c | No | BSP ONLY. The fewest non-CpG cytosines the ORIGINAL sequence under a primer must carry - the rule that makes a BSP primer bisulfite-SPECIFIC, because those cytosines become T only if conversion worked. A primer with none anneals to untreated DNA just as well and the assay silently reports on template that was never converted. In nt. | |
| design_in_island | 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. | |
| island_min_length | No | minimum island length (cpgplot -minlen); unset takes the preset's. In bp. Advanced. | |
| island_min_obs_exp | No | minimum observed/expected CpG (cpgplot -minoe); unset takes the preset's. Advanced. | |
| island_min_percent | No | minimum %C+%G (cpgplot -minpc); unset takes the preset's. In %. Advanced. | |
| max_cpg_distance_from_3 | No | MSP ONLY. How close to the 3' end the last CpG must sit. A mismatch discriminates most strongly at the 3' end, because that is where the polymerase extends. In nt. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| assay | Yes | which assay was designed, echoed so a result never has to be guessed at |
| count | Yes | how many pairs were found |
| pairs | Yes | the primer pairs, best first: each with both oligos, their coordinates on the ORIGINAL unconverted sequence, Tm, GC, CpG count and the non-CpG C conversion check |
| forward | Yes | the best pair's forward primer (wire into pcr_amplify) |
| islands | Yes | CpG islands in the record (EMBOSS cpgplot criteria) - what a methylation assay should be aimed at |
| reverse | Yes | the best pair's reverse primer |
| islandCount | Yes | how many CpG islands were found |
| methylatedPairs | Yes | MSP: the pairs specific for the METHYLATED allele. Empty under BSP |
| unmethylatedPairs | Yes | MSP: the pairs specific for the UNMETHYLATED allele - the other half of the assay, and the control that tells a negative from a failed reaction. Empty under BSP |
design_codehopAInspect
Design CODEHOP hybrid oligos from a block of aligned PROTEIN - for homologues too diverged for nucleotide-level design to see at all.
| Name | Required | Description | Default |
|---|---|---|---|
| table | 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 is wrong in a way nothing downstream can detect, so picking one here would silently pick a host (§1). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| strand | No | which strand to design on. `both` returns forward and reverse sets, which is what a PCR needs. | both |
| max_run | No | longest single-base run allowed; 2003's stated polynucleotide run limit. A primer exceeding it is rejected. In nt. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| clamp_tm | 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 the buffer `conditions` names. In °C. | |
| alignment | 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 none worth the name. | |
| weighting | 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. | pb |
| conditions | 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 back to pydna's Taq defaults (SantaLucia & Hicks 2004 table, 250 nM primer, Owczarzy 2008 salt correction) when there are none. Advanced. | |
| base_cutoff | No | minimum predicted probability for a base to enter the degenerate core. Advanced. | |
| block_index | No | which gapless block to design in, 0-based, ordered as `gaplessBlocks` returns them (blocks of at least 8 ungapped columns). Unset = the first. | |
| core_lengths | No | core lengths the scan tries, in residues — every length here is scanned and the best-scoring core kept. Advanced. | |
| alignment_fasta | No | an aligned PROTEIN FASTA, when there is no upstream alignment to wire. | |
| genetic_code_id | No | NCBI `transl_table` id for the codon-to-residue map. Advanced. | |
| max_clamp_length | 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 expects. In nt. Advanced. | |
| max_core_degeneracy | No | degeneracy ceiling for the 3' core (Rose 2003 step 7: "a maximum degeneracy of 128"). |
Output Schema
| Name | Required | Description |
|---|---|---|
| table | Yes | which codon table the clamp was back-translated through, named so a design is never unattributable |
| forward | Yes | the first forward oligo, clamp + core |
| primers | Yes | the designed oligos: each with its degenerate 3' core, its consensus 5' clamp, the residues it covers and its degeneracy |
| reverse | Yes | the first reverse oligo |
| blockCount | Yes | how many gapless blocks the alignment offers, so a caller can see there were others to choose |
| rejections | Yes | why each candidate position was rejected - degeneracy, run length, or a clamp that could not reach the Tm |
| primerCount | Yes | how many oligos were designed |
design_combinatorial_libraryBInspect
Design a combinatorial library in one step: SLOTS, each offering a bin of interchangeable parts, plus the CONSTANTS every member carries.
| Name | Required | Description | Default |
|---|---|---|---|
| bins | 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. | |
| rules | 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). Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| topology | No | Gibson only: which products to enumerate per member. Values: circular (Circular), linear (Linear), both (Both). Advanced. | circular |
| chemistry | 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)), concat (Concatenation). | gibson |
| constants | No | parts every member carries, assembled before the slot choices — the backbone and any fixed linker. | |
| max_members | No | cap on Cartesian members enumerated, before pruning. Advanced. | |
| min_homology_bp | No | Gibson only: shortest terminal homology that counts as a join. In bp. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| built | Yes | members that closed at least one construct |
| pruned | Yes | every combination removed before assembly, each with the rule that removed it — never dropped silently |
| record | Yes | the first member's construct, as a record |
| members | Yes | every built member: its slot→part lineage, the parts assembled, the construct(s) and any flaws |
| reading | Yes | what was enumerated, built and pruned, read off the run |
| cartesian | Yes | Cartesian product size, before pruning (the product of the bin sizes) |
design_degenerate_primersAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| seed | 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 algorithm is wrm. Advanced. | |
| skip | No | bases excluded at each end of every sequence (`-skip`). In nt. Advanced. | |
| limit | No | how many pairs to return, best coverage first. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| length | No | oligomer length (DegePrime `-l`). In nt. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| algorithm | 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 grade each other, and REFUSES a window too large to solve rather than guessing - the problem is NP-hard. | wrm |
| alignment | 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 substitute. | |
| min_depth | No | fewest gapless sequences a window needs before it is reported at all (`-depth`). Advanced. | |
| iterations | No | WRM restarts (`-iter`). Only applies when algorithm is wrm. Advanced. | |
| max_product | No | longest product, in TRIMMED alignment columns. In col. | |
| min_product | No | shortest product, in TRIMMED alignment columns. In col. | |
| trim_cutoff | 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. | |
| max_degeneracy | 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. | |
| alignment_fasta | No | an aligned FASTA to scan, when there is no upstream alignment to wire. Sequences must already BE aligned - equal length, gaps as `-`. | |
| exhaustive_mer_limit | No | largest number of distinct mers `exhaustive` will attempt before refusing a window. Only applies when algorithm is exhaustive. Advanced. | |
| min_fraction_matching | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| pairs | Yes | the primer pairs, best coverage first: both oligos in IUPAC letters, their degeneracy, the fraction of the family each binds, and the product span in trimmed columns |
| forward | Yes | the best pair's forward oligo, IUPAC. Empty when no pair satisfied the constraints |
| reverse | Yes | the best pair's reverse oligo AS ORDERED (reverse-complemented). Empty when no pair satisfied the constraints |
| windows | Yes | every scanned window with its degeneracy, entropy and coverage - the scan behind the pairs |
| pairCount | Yes | how many pairs were found |
| keptColumns | Yes | which columns of the ORIGINAL alignment survived trimming - trimmed column 40 is not alignment column 40, and this is the map back |
| degeneracyCoerced | Yes | true when the ceiling was lowered, so a run never silently answers a different question than it was asked |
| maxDegeneracyUsed | Yes | the degeneracy ceiling actually applied - LOWER than asked when no combination of IUPAC positions can multiply to the request |
design_expression_variantsAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| cds | 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. | |
| seed | No | seed for the solver's random draws, so a listed variant can be regenerated exactly. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| gc_max | No | maximum GC fraction (0-1); set with gc_min. Advanced. | |
| gc_min | No | minimum GC fraction (0-1); set with gc_max. Advanced. | |
| feature | 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 both. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| postures | 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 single best codon, so rare codons stay at their natural rate; harmonize = put each codon at the same relative adaptiveness it had in the gene's native host, so the elongation rhythm (and any pause the protein folds around) survives the transfer; native_initiation = leave nt +1…+37 of the coding sequence exactly as they are and match the host's codon usage only downstream, so the redesign cannot add secondary structure to the window Kudla found dominant. The set IS the deliverable — asking for one gets one, and there is no hidden default of three. | |
| upstream | 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. | |
| gc_window | No | window in bp the GC bounds apply over (whole sequence when unset). Advanced. | |
| host_table | 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 table someone built or fetched. Leave unset and the active table is used. | |
| rare_below | 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-independent definition. | |
| native_table | 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 table from `host_table`: harmonising a host against itself is a difference of zero. | |
| genetic_table | No | genetic code for the translation constraint (default Standard). Advanced. | Standard |
| avoid_patterns | No | literal patterns (restriction sites, homopolymers) every variant must not contain. | |
| host_table_tsv | 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, and a typed one is indistinguishable from a real one in the result. TSV: codon<TAB>count. Advanced. | |
| host_table_name | No | how to name that table on every score it produced (e.g. "E. coli K-12, Kazusa"), so a reported CAI is attributable. | |
| native_table_tsv | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| region | Yes | what was actually redesigned — the selection when there is one, otherwise the whole open record, naming the STRAND and where it came from. Empty when the caller passed `cds` outright, because then there is no region, only a sequence they named |
| report | Yes | the whole comparison as Markdown — table, what each design trades, the provenance of every number, and the sequences — so it survives outside the transcript |
| protein | Yes | the protein every variant encodes — asserted per variant, not assumed |
| records | Yes | the variants as sequence RECORDS, so the run leaves the user holding the designs it describes |
| skipped | Yes | postures that were asked for and could not run, each with the reason |
| best_cai | Yes | the posture reaching the highest CAI — a ranking on ONE axis, never a recommendation |
| distinct | Yes | how many of the variants are DIFFERENT sequences |
| variants | Yes | one entry per posture: its sequence, what it was optimising for, what it trades away, and every score with the engine that produced it |
| least_structured | Yes | the posture whose initiation window folds least tightly (the highest, least-negative dG) |
design_free_codesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | 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). | generate |
| limit | No | stop after this many codewords. 0 = take the whole code. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| length | No | barcode length k. The search is over the whole 4^k space, so cost rises steeply with it. | |
| max_gc | No | reject a candidate above this GC fraction. 0 = no limit. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| barcodes | No | the set to prune — required when `mode` is `prune`, ignored when generating. Only applies when mode is prune. | |
| reserved | 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 owns. | |
| max_errors | No | how many insertions/deletions/substitutions each codeword must tolerate. Each extra error costs most of the code. | |
| max_homopolymer | No | reject a candidate with a run of this many identical bases. 0 = no limit. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many codewords came back |
| dropped | Yes | prune only: the codewords removed because their decode spheres collided — a user pruning their own set needs to know which indexes to stop using, not how many |
| barcodes | Yes | the codewords — generated, or the ones that survived pruning |
design_fusion_site_primersBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzyme | No | the Type-IIS enzyme the assembly will use. | BsaI |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the template to amplify — wire a record, name a library document, or leave unset to use the open record. | |
| target_tm | No | target annealing temperature for the template-binding footprint. In °C. | |
| buffer_bases | No | 5' buffer bases outside the recognition site, so the enzyme has somewhere to sit (NEB recommends 6 nt). Advanced. | AAAAAA |
| left_overhang | 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 | Yes | the top-strand overhang to leave at the END of the released part. |
Output Schema
| Name | Required | Description |
|---|---|---|
| forward | Yes | the forward primer, 5'→3': buffer, recognition site, spacer, your overhang, then the annealing footprint |
| product | Yes | what the pair amplifies, tails included |
| reverse | Yes | the reverse primer, same construction on the other end |
| forwardTm | Yes | melting temperature of the forward primer's ANNEALING footprint — the tail does not bind the template on the first cycle |
| reverseTm | Yes | the same for the reverse primer; the pair is matched, so a gap between these two is the thing to notice |
| releasedPart | Yes | what the enzyme cuts OUT of that product — the part that actually enters the assembly, carrying your two overhangs |
design_gene_fragment_orderARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| names | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| feature | No | order a named feature of the open record instead of the whole record: the insert rather than the vector it sits in. Advanced. | |
| product | 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)), idt-eblocks (eBlocks Gene Fragments (300–1,500 bp)). | idt-gblocks |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequences | 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. | |
| plate_name | No | the plate's name, which becomes the worksheet's name. Several plates get ' (2)', ' (3)' appended. | Plate 1 |
| phosphorylate | No | ask for 5' phosphorylation on every fragment. IDT offers it for blunt cloning only. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | every plate as header-first rows in the template's column shape, keyed by worksheet name: what the .xlsx holds |
| sheets | Yes | one entry per PLATE: its worksheet name and every laid-out well, each with the published limits it sits outside |
| columns | Yes | the template's header row |
| profile | Yes | the vendor profile the length range came from, with its page and retrieval date |
| reading | Yes | what the order is, generated from the laid-out plates |
| refused | Yes | every fragment left OUT, with the reason |
| plateCount | Yes | how many plates the fragments needed |
| plateMinimum | Yes | set when the product takes a minimum per plate and a plate falls under it; empty otherwise |
design_genetic_circuitARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| logic | 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 (AND is `0001`). | AND |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| groups | 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. | |
| library | No | the characterized gate library to build from. Each was measured in one host under one growth condition, and the prediction inherits both. | Eco1C1G1T1 |
| sensors | No | comma-separated input sensors the search may use. Leave unset to consider every sensor the library carries. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| reporters | No | comma-separated output reporters the search may use. Leave unset to consider all of them. Advanced. | |
| max_assignments | 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 a slow one. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| dna | Yes | the construct broken into devices and parts, each with its own sequence, plus the solved device order and every placement constraint the library declares |
| score | Yes | the predicted dynamic range: the dimmest ON output divided by the brightest OFF, across every input combination |
| curves | Yes | each assigned gate's transfer function sampled around its own midpoint, with this design's operating points on it — one curve per physical gate that won a row, so a group won by two gates gives two curves |
| netlist | Yes | the NOR/NOT netlist synthesized from the logic function, and the table it was checked to compute |
| sequence | Yes | the construct's DNA, the devices concatenated in the order the library's placement rules put them |
| toxicity | Yes | what the circuit costs the host: relative growth per truth-table row, the worst row, and per-gate detail — plus how many of the assigned gates actually carried a measured growth table, because a growth of 1.00 means something different when nothing was measured |
| libraries | Yes | every shipped library with its host, growth conditions and gate count, so a caller can choose one |
| placement | Yes | how the device order was solved: the arrangement including the library's landing pads, how many of its placement constraints bound this construct, and any rule whose operator is not implemented |
| assignment | Yes | which sensors, gate groups and reporters the winning design uses |
| truthTable | Yes | every input combination with its logic values and its analog levels in RPU, per node |
| explanation | Yes | the derivation chain: conclusion, interpretation, earned cautions and machinery, generated from this run |
| curvesFigure | Yes | the curves above drawn as the panel draws them: one panel per gate, all on the same log-log axes, the response as a line and this design's operating points on it, ON in bluish green and OFF in vermillion |
design_gibson_primersARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| overlap | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| circular | No | close the ring: the last fragment also overlaps the first. | |
| fragments | No | the fragments to join, IN ASSEMBLY ORDER — wire upstream `record` outputs here, or list library document names/ids. | |
| target_tm | No | target annealing Tm for each primer's 3' footprint. In °C. | |
| conditions | 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 Taq defaults when there are none. Advanced. | |
| min_footprint | No | shortest annealing footprint the designer may settle for (pydna's `limit`). In nt. Advanced. | |
| include_subject | No | put the node's subject first, as the backbone. | |
| synthesis_scale | 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. | auto |
Output Schema
| Name | Required | Description |
|---|---|---|
| cost | Yes | what the oligo set costs at a vendor's published list price: per oligo the product, per-base rate and price, plus the set total, the oligos no listed product covers, and the date the prices were read. One supplier's list price, not a quote |
| overlap | Yes | homology designed between neighbours (bp) |
| primers | Yes | per fragment: the tailed amplicon its primers make, that amplicon's length, and both primers with tail, footprint, length and footprint Tm |
| circular | Yes | whether the ring was closed |
| amplicons | Yes | the PCR products these primers make, as sequence RECORDS carrying each fragment's features at their shifted positions. THIS is what assembles: wire it into `gibson_assemble.fragments`, not the untailed fragments |
| costTotal | Yes | list-price total for the oligos that could be priced (see `cost.unpriced` for any that could not) |
| conditions | Yes | the buffer the target Tm was measured in — salt, magnesium, dNTPs, oligo concentration and the salt-correction method — or a note saying pydna's defaults were used |
| primerCount | Yes | oligos to order (two per fragment) |
design_hcr_probesARead-onlyInspect
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 even probe carrying half of the chosen amplifier's initiator.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| max_gc | No | highest percent G+C of a tile. In %. | |
| min_gc | No | lowest percent G+C of a tile. In %. | |
| channel | No | HCR amplifier whose split initiator the pair carries; one channel per target in a multiplexed experiment. | B1 |
| dtm_max | No | largest allowed difference between the halves' melting temperatures. In °C. Only applies when dtm_filter is true. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| max_gibbs | No | least stable RNA:DNA free energy to accept. In kcal/mol. | |
| min_gibbs | No | most stable RNA:DNA free energy to accept (at 37 °C, 0.33 M Na⁺). In kcal/mol. | |
| tile_size | No | length of the target window each pair covers, both halves and the 2 nt gap. In nt. Advanced. | |
| dtm_filter | No | also require the two halves' melting temperatures to agree. Advanced. | |
| max_probes | No | most probe pairs to return. | |
| target_gibbs | No | free energy the selection ranks tiles by closeness to. In kcal/mol. | |
| alignment_sam | 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. | |
| max_hairpin_tm | No | drop a tile whose primer3 hairpin melts at or above this. In °C. Advanced. | |
| max_run_length | No | window length for the C and G run check. In nt. Advanced. | |
| num_hits_allowed | No | most alignments a tile may have and still be kept (its own locus counts as one). Only applies when alignment_sam is set. | |
| max_run_mismatches | No | bases in that window allowed to differ from the run base. In nt. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| pairs | Yes | the selected probe pairs, ranked by closeness to the target free energy, each with both oligos, its 1-based start, G+C, Tm, half-Tm difference, free energy and genome hits |
| stages | Yes | how many tiles each stage kept, in pipeline order |
| pairCount | Yes | how many probe pairs were selected |
| orderTable | Yes | every odd then every even oligo as a Name/Sequence table for plate ordering |
| tilesFasta | Yes | the tiles that pass the run and hairpin checks, as FASTA, for bowtie2 -k 3 -f |
| explanation | Yes | the derivation chain: conclusion, interpretation and machinery, generated from this run |
design_ish_probesBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dnac1 | No | concentration of the higher-concentration strand, typically the probe, in the melting-temperature calculation (OligoMiner `--dnac1`). In nM. | |
| dnac2 | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| max_gc | No | highest percent G+C to accept. In %. | |
| max_tm | No | highest melting temperature to accept. In °C. | |
| min_gc | No | lowest percent G+C to accept. In %. | |
| min_tm | No | lowest melting temperature to accept, AFTER the formamide correction. In °C. | |
| origin | 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. | |
| probes | No | how many probe sets to return. Only applies when oligos_per_probe is set. | |
| sodium | No | monovalent cation concentration of the hybridization buffer. In mM. | |
| overlap | No | report every window that qualifies, including overlapping ones. Off by default because overlapping oligos cannot be used together in one probe. Advanced. | |
| rank_by | No | feature that ranks the sets inside that band. Values: centrality (Centrality on the region), size (Compactness), homogeneity (Even spacing). Only applies when oligos_per_probe is set. Advanced. | size |
| spacing | No | bases forced between consecutive oligos. In nt. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| filter_by | No | feature that defines the band of acceptable sets. Values: centrality (Centrality on the region), size (Compactness), homogeneity (Even spacing). Only applies when oligos_per_probe is set. Advanced. | centrality |
| formamide | No | formamide in the hybridization buffer; it lowers every melting temperature by about 0.65 °C per percent. In %. | |
| kmer_dump | 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. Advanced. | |
| max_length | No | longest oligo to accept; the tiler grows a window until one fits, so a wide range yields more probes. In nt. | |
| min_length | No | shortest oligo to accept. In nt. | |
| prohibited | No | comma-separated subsequences an oligo may not contain; the default bans homopolymer runs, which hybridize promiscuously. Advanced. | AAAAA,TTTTT,CCCCC,GGGGG |
| kmer_length | No | k, the k-mer length counted in kmer_reference (OligoMiner's README builds 18); a dump carries its own. In nt. Only applies when kmer_reference is set. | |
| screen_mode | 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 only), zero (No alignment at all). Only applies when alignment_sam is set. | lda |
| alignment_sam | No | SAM the candidates were aligned with, for off-target screening. Without it the oligos are returned UNSCREENED and the result says so. | |
| kmer_canonical | No | count a k-mer and its reverse complement as one (jellyfish -C). Off as OligoMiner's dictionary is; for a dump it must match how the dictionary was counted. Advanced. | |
| kmer_reference | 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 UNCHECKED and the result says so. | |
| kmer_threshold | No | drop an oligo holding any k-mer that occurs this many times or more in the reference. | |
| filter_threshold | No | width of the band around the best set, as a fraction of its own value. Only applies when oligos_per_probe is set. Advanced. | |
| oligos_per_probe | No | oligos to gather into one probe. Leave unset to return every surviving oligo instead of a set. | |
| hybridization_temperature | 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 applies when alignment_sam is set. | |
| max_off_target_probability | No | keep an oligo whose modelled chance of a real off-target site is below this. Only applies when alignment_sam is set. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| kmer | Yes | the k-mer screen's reading of each oligo it saw: its start, the highest count charged to it, and whether it was kept. Absent when no k-mer reference or dump was given |
| oligos | Yes | every oligo that survived all stages, in target order |
| probes | Yes | the chosen probe sets, best first, each with its oligos and its three scores |
| stages | Yes | what each stage took in, put out, and removed - with the reasons named |
| coverage | Yes | the coverage track, gaps, spacings and the Tm/G+C distributions a renderer draws |
| oligoCount | Yes | how many oligos survived |
| explanation | Yes | the derivation chain: conclusion, interpretation and machinery, generated from this run |
| coveredFraction | Yes | fraction of the target covered by at least one surviving oligo (0-1) |
design_knockout_packageAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| guides | No | how many guides to carry into the package, best-scoring first. The rest are the alternatives, not filler. | |
| insert | 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. | |
| subject | No | the molecule to edit — wire a record or name a library document; leave unset to edit the open record. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| nuclease | 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 (SaCas9: NNGRRT (3')), SaCas9-KKH (SaCas9-KKH: NNNRRT (3')), AsCas12a (AsCas12a: TTTV (5')), LbCas12a (LbCas12a: TTTV (5')), enAsCas12a (enAsCas12a: TTTV (5')). | SpCas9 |
| primer_tm | No | target melting temperature for the screening primers [°C] — follows your polymerase and buffer. In °C. Advanced. | |
| arm_length | 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-400 nt synthetic, up to ~800 bp cloned). In bp. | |
| target_end | Yes | end of the gene to knock out (0-based, exclusive). In bp. | |
| insert_name | No | what the insert is called in the protocol and on the order form. | |
| target_name | No | what the target is called, so every mark, primer and order line names its subject. | target |
| screen_flank | 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 colony from plasmid carry-over. In bp. | |
| target_start | Yes | start of the gene to knock out (0-based, inclusive). In bp. | |
| max_mismatches | No | mismatch ceiling for the off-target search within this molecule. Advanced. | |
| replace_target | 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 the insert (a point insertion), so this must be ON to knock one CDS in for another. Empty insert + this = a clean deletion of the target. Advanced. | |
| restriction_enzymes | No | cloning enzymes whose recognition site must NOT appear in a spacer. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| donor | Yes | the repair template: both arms with their genomic spans, the insert, and the junctions to sequence across |
| marks | Yes | every span this package names, ready for the map |
| order | Yes | the fragments and oligos to buy, each with the design decision it comes from |
| steps | Yes | the protocol in the order it is done |
| chosen | Yes | the guide the package was built around |
| guides | Yes | every guide inside the target, scored, best first |
| record | Yes | the repair template as a sequence record, so the run leaves the user holding the thing to order |
| report | Yes | the whole package as Markdown — protocol, order form, guides, template, screening and marks — so it survives outside the transcript |
| screening | Yes | the screening PCR: the pair, the two product lengths, and the span they cover |
| offTargets | Yes | the off-target census for the chosen spacer WITHIN this molecule, with the scope stated |
design_lamp_primersAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| gc_max | 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. | |
| gc_min | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| max_sets | No | how many sets to return, best first. | |
| length_max | 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. | |
| length_min | 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. | |
| region_end | No | 0-based inclusive end. Unset = the whole sequence. Advanced. | |
| tm_loop_max | No | Tm window for the loop primers LF / LB - upper bound. Unset = the preset for this template's GC class. In °C. Advanced. | |
| tm_loop_min | No | Tm window for the loop primers LF / LB - lower bound. Unset = the preset for this template's GC class. In °C. Advanced. | |
| loop_primers | No | design LF/LB as well. They are optional in LAMP and accelerate the reaction. | |
| region_start | 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. | |
| tm_inner_max | 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_inner_min | 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_outer_max | 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_outer_min | 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. | |
| loop_span_max | 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. | |
| loop_span_min | 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. | |
| outer_gap_max | No | F3 to F2 and B3 to B2 gap. THE TWO AUTHORITIES DISAGREE here too: PrimerExplorer V5 says 0-60, the Eiken genome site 0-20 - upper bound. Unset = the preset for this template's GC class. In bp. Advanced. | |
| outer_gap_min | No | F3 to F2 and B3 to B2 gap. THE TWO AUTHORITIES DISAGREE here too: PrimerExplorer V5 says 0-60, the Eiken genome site 0-20 - lower bound. Unset = the preset for this template's GC class. In bp. Advanced. | |
| end_stability_dg | 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 | No | how many terminal bases the end-stability rule measures (manual §2.2: 6). In nt. Advanced. | |
| amplified_span_max | 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 reading - upper bound. Unset = the preset for this template's GC class. In bp. Advanced. | |
| amplified_span_min | 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 reading - lower bound. Unset = the preset for this template's GC class. In bp. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| b3 | Yes | the best set's B3 outer primer |
| f3 | Yes | the best set's F3 outer primer |
| bip | Yes | the best set's BIP (B1c + B2), as ordered |
| fip | Yes | the best set's FIP (F1c + F2), as ordered |
| sets | Yes | the primer sets, best first: six regions in the literature order with every measurement that decided each one |
| offset | Yes | where the designed-in stretch starts in the record: add it to every position above for record coordinates. 0 unless a region was given |
| setCount | Yes | how many sets were found |
| constraints | Yes | every window the search actually ran under, so a readout never has to restate them or guess which preset applied |
| targetClass | Yes | which preset the search ran under - atRich, normal or gcRich, chosen from the template's own GC content (manual §4.3) |
| penaltyTerms | Yes | what the best set's rank is MADE OF - one entry per criterion with the value measured, the window it was judged against and its cost. The costs sum to the penalty |
design_ligation_independent_primersBRead-onlyInspect
Design the PCR primers a ligation-independent reaction needs — LIC, SLIC, In-Fusion, CPEC or USER: a Tm-matched pair per amplified fragment, in the order given.
| Name | Required | Description | Default |
|---|---|---|---|
| eklic | No | LIC only: use the Ek/LIC vectors' own fixed extensions (Novagen TB163) instead of designing an arm. One insert only, and the vector is supplied cut. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| arm_nt | No | the homology arm on ONE primer, which is the unit every one of these authorities states. Left unset, the method's own recommended arm. Does not apply to USER, which finds its extension instead. In nt. | |
| method | No | the cloning method, which decides what the tail is: LIC's arm is the Ek/LIC vectors' fixed overhang, SLIC's and CPEC's are ranges, In-Fusion widens its own for more than one insert, and USER's is a complementary dU pair whose length the search finds. Values: lic (LIC), slic (SLIC), in-fusion (In-Fusion), cpec (CPEC), user (USER). | in-fusion |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| backbone | No | whether the first fragment is amplified with the others (pydna splits each junction across the two neighbouring primers, so the junction is twice the arm) or supplied already cut (the whole arm goes on its neighbour's primer, and the junction is the arm). Values: amplified (Amplified), linearized (Linearized). | amplified |
| circular | No | close the ring: the last fragment also overlaps the first. USER does not wrap on its own, so a USER ring needs a vector named below. | |
| eklic_tag | No | Ek/LIC only: keep the C-terminal tag, or close the insert with the in-frame stop TB163 gives for a construct that omits it. Only applies when eklic is true. Advanced. | |
| fragments | No | the fragments to join, IN ASSEMBLY ORDER, the first being the backbone — wire upstream `record` outputs here, or name library documents. | |
| target_tm | No | target annealing Tm for each primer's 3' footprint. In °C. | |
| conditions | 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 Taq defaults when there are none. Advanced. | |
| user_vector | No | USER only: join the two outer ends to a vector that already carries fixed 3' extensions, which is how a USER construct closes a ring. pNEB206A is the vector the method's own paper uses. Values: none (None (linear chain)), pNEB206A (pNEB206A). Only applies when method is user. | none |
| min_footprint | No | shortest annealing footprint the designer may settle for (pydna's `limit`). In nt. Advanced. | |
| include_subject | No | put the node's subject first, as the backbone. | |
| user_vector_end | No | USER with a vector: which of its two DIFFERENT extensions the first fragment's forward primer matches, which is what sets the insert's orientation in the vector. Values: left (Left (GGAGACAU)), right (Right (GGGAAAGU)). Only applies when user_vector is pNEB206A. Advanced. | left |
Output Schema
| Name | Required | Description |
|---|---|---|
| armNt | Yes | the arm on one primer |
| primers | Yes | per amplified fragment: the tailed amplicon its primers make, that amplicon's length, and both primers with tail, footprint, length and footprint Tm |
| summary | Yes | what was designed, naming the method and its chemistry |
| reactants | Yes | the molecules that actually react, as sequence RECORDS: the amplicons where primers were designed, and any fragment supplied cut as itself. THIS is what to wire into `ligation_independent_clone.fragments`, not the untailed fragments |
| armVerdict | Yes | whether that arm is one the method's authority stands behind, in its own words |
| extensions | Yes | USER only: per junction, the two fragments it joins, the single-stranded 3' extension each side gets (which is also where the dU sits), both tails, and whether that length is one the authority stands behind |
| junctionBp | Yes | the homology the design creates at each junction — the number `ligation_independent_clone.arm_nt` needs for the reaction to be predicted as designed |
| vectorEnds | Yes | USER with a vector: the two FIXED extensions that close the ring, which tail went on which outer primer, and where they come from. Not designed, because the vector was manufactured with them. Null when no vector is named, since a linear chain has no fixed ends to close on |
| primerCount | Yes | oligos to order (two per amplified fragment) |
design_merfish_probesARead-onlyInspect
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 again, select probes that cover every on-bit evenly with least overlap, and drop probes complementary to one another.
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | seed for the random draws in readout assignment and selection. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| max_gc | No | highest G+C of a target region (exclusive). In %. | |
| max_tm | No | highest melting temperature of a target region (exclusive). In °C. | |
| min_gc | No | lowest G+C of a target region (exclusive). In %. | |
| min_tm | No | lowest melting temperature of a target region (exclusive). In °C. | |
| spacer | No | bases between each readout and the target. Advanced. | A |
| trials | No | selection runs; the one with the most even on-bit coverage is kept. Advanced. | |
| barcode | No | the gene's codeword, one 0 or 1 per bit, 1 where the bit is on. | |
| rtrna_k | No | k-mer length of the rRNA/tRNA screen. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| probe_nm | No | concentration of each probe. In nM. Advanced. | |
| readouts | No | the readout sequences as FASTA, one per bit, in bit order. | |
| formamide | No | formamide in the hybridization buffer. In %. Advanced. | |
| sodium_mm | No | monovalent salt of the hybridization buffer. In mM. Advanced. | |
| t7_length | No | bases of the reverse primer lost in in vitro transcription. In nt. Only applies when reverse_primer is set. Advanced. | |
| target_id | No | the transcript to design for, by its FASTA id. Empty: the transcript whose sequence is the subject's. Advanced. | |
| expression | 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. | |
| cross_talk_k | No | k-mer length of the library-wide cross-hybridization screen. Advanced. | |
| max_rtrna_ot | No | highest rRNA/tRNA off-target count to keep (exclusive); 0.5 keeps only regions with none. Advanced. | |
| specificity_k | No | k-mer length of the specificity and readout off-target counts. Advanced. | |
| target_length | No | length of each target region. In nt. | |
| transcriptome | 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. | |
| forward_primer | No | forward primer; its reverse complement ends the oligo. Only applies when reverse_primer is set. Advanced. | |
| reverse_primer | No | reverse primer, T7 promoter at its 5' end. Empty: no primers are added. Advanced. | |
| min_specificity | No | lowest specificity to keep (exclusive): the share of a region's k-mers found only in this gene. | |
| rtrna_reference | 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. | |
| one_bit_per_probe | No | give each probe copies of a single readout. Advanced. | |
| readout_assignment | No | how each probe's on-bits are drawn: balanced keeps every on-bit equally used down the transcript. Advanced. | balanced |
| readouts_per_probe | No | readout sequences carried by each probe, split between its two ends. | |
| probes_per_transcript | No | probes to select. | |
| max_readout_ot_increase | No | drop a probe whose readouts add this many expression-weighted off-target k-mers or more (the single-molecule pipeline's check). Empty: not checked. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| probes | Yes | the selected encoding probes in selection order, each with its 0-based shift, target, G+C, Tm, specificity, isospecificity, readouts, barcode and the oligo to order |
| report | Yes | the transcript-level report: probes, probes per on-bit, the fewest on any bit, and how many could be placed without overlap before and after selection |
| stages | Yes | what each stage took in and kept, in pipeline order, with the reason a skipped stage did not run |
| orderTable | Yes | every probe as a Name/Sequence table for pool ordering |
| probeCount | Yes | how many encoding probes were kept |
| explanation | Yes | the derivation chain: conclusion, interpretation and machinery, generated from this run |
design_multisite_primersAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| k | No | potassium concentration. In mM. Advanced. | |
| mg | No | magnesium concentration — the term the Owczarzy corrections are most sensitive to. In mM. Advanced. | |
| na | No | sodium concentration the salt correction is computed for. In mM. Only applies when gc_value_set is Schildkraut_1965 or Primer3 or Ahsen_2001. Advanced. | |
| cds | Yes | the CDS nucleotide sequence, in frame from the start codon. | |
| dntp | No | total dNTP concentration, which chelates magnesium and so lowers the effective Mg²⁺. In mM. Advanced. | |
| seed | No | seed for the codon draw. The same seed and the same request give the same oligos; change it to re-roll. | |
| tris | No | Tris concentration. In mM. Only applies when gc_value_set is Schildkraut_1965 or Primer3 or Ahsen_2001. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| organism | No | codon-usage table the synonymous choice is drawn from. | e-coli |
| mutations | 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. | |
| precision | No | decimal places the reported Tm is rounded to. In dp. Advanced. | |
| temp_weight | No | score weight on Tm deviation. Advanced. | |
| use_primer3 | No | apply primer3 hairpin / homodimer / heterodimer penalties. Advanced. | |
| gc_value_set | No | which published GC-formula parameter set the melting temperature is computed under. Values: QuickChange (QuikChange (the kit manufacturer’s own formula)), Chester_1993 (Marmur-Doty (Chester & Marshak 1993)), Schildkraut_1965 (Schildkraut & Lifson 1965 (Marmur-Doty + log[Na⁺])), Primer3 (Primer3Plus product Tm (Biopython’s default set)), Ahsen_2001 (von Ahsen 2001 (accuracy against ease of use)). Advanced. | QuickChange |
| five_end_flank | No | explicit 5' context. Left empty, 60 bp is read off the open record either side of the CDS. Advanced. | |
| max_gc_content | No | highest GC accepted. In %. Advanced. | |
| min_gc_content | No | lowest oligo GC accepted. In %. Advanced. | |
| max_primer_size | No | longest oligo. In nt. Advanced. | |
| max_temperature | No | highest Tm threshold swept. In °C. | |
| min_primer_size | No | shortest oligo. In nt. Advanced. | |
| min_temperature | No | lowest Tm threshold the growth scan sweeps. In °C. | |
| temp_range_size | No | width of the acceptable Tm window around the reaction temperature. In °C. Advanced. | |
| three_end_flank | No | explicit 3' context, the partner of `five_end_flank`. Advanced. | |
| gc_content_weight | No | score weight on GC overflow. Advanced. | |
| max_five_end_size | No | longest 5' lead. In nt. Advanced. | |
| min_five_end_size | No | bases between the 5' terminus and the first mutated codon, minimum. In nt. Advanced. | |
| max_three_end_size | No | longest 3' tail. In nt. Advanced. | |
| min_three_end_size | No | bases between the last mutated codon and the 3' terminus, minimum. In nt. Advanced. | |
| primer_size_weight | No | score weight on oligo length deviation. Advanced. | |
| temp_threshold_step | No | step between Tm thresholds tried. In °C. Advanced. | |
| five_end_size_weight | No | score weight on 5'-lead length deviation. Advanced. | |
| use_degeneracy_codon | No | collapse a site's codons into one IUPAC-degenerate codon (upstream's default). Off, each amino gets its own oligo. | |
| three_end_size_weight | No | score weight on 3'-tail length deviation. Advanced. | |
| non_overlapping_primers | No | forbid oligos from overlapping each other. Upstream ranks only the LAST split's solutions with this on (a reproduced bug, see the port header). Advanced. | |
| mutation_coverage_weight | No | score weight on how many of the requested aminos the design actually delivers — upstream's dominant term. Advanced. | |
| hairpin_temperature_weight | No | score weight on hairpin Tm. Advanced. | |
| codon_usage_frequency_threshold | No | discard synonymous codons rarer than this fraction in the chosen organism. | |
| primer_dimer_temperature_weight | No | score weight on dimer Tm. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| seed | Yes | the seed this design was drawn with — change it to re-roll, keep it to reproduce |
| oligos | Yes | one oligo per site, with its span, Tm, GC and the degenerate codons it installs |
| failureCount | Yes | constraint breaches in the winning solution (0 = every oligo inside its limits) |
| fullSequence | Yes | the construct the oligo coordinates are on: flank + CDS + flank |
| mutationCoverage | Yes | fraction of the requested amino acids the design actually delivers, 0–1 |
| reactionTemperature | Yes | the ONE annealing temperature the winning solution is built for |
design_mutagenesis_primersAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| cds | Yes | the CDS nucleotide sequence, in frame from the start codon. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| mutation | Yes | the change as [WT][pos][MUT], e.g. "W140F" (1-based residue). | |
| tm_model | 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 (SantaLucia nearest-neighbor (Biopython Tm_NN defaults)), wallace (Wallace rule (4 °C per G·C, 2 °C per A·T)), gc:Chester_1993 (GC formula: Marmur-Doty (Chester & Marshak 1993)), gc:QuickChange (GC formula: QuikChange (the kit manufacturer’s own formula)), gc:Schildkraut_1965 (GC formula: Schildkraut & Lifson 1965 (Marmur-Doty + log[Na⁺])), gc:Wetmur_Melting_1991 (GC formula: Wetmur 1991, DNA (MELTING 4.3 approximate mode)), gc:Wetmur_RNA_1991 (GC formula: Wetmur 1991, RNA), gc:Wetmur_DNA_RNA_1991 (GC formula: Wetmur 1991, RNA/DNA hybrid), gc:Primer3 (GC formula: Primer3Plus product Tm (Biopython’s default set)), gc:Ahsen_2001 (GC formula: von Ahsen 2001 (accuracy against ease of use)). | santalucia |
| codon_usage_tsv | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| outer | Yes | the constant outer primer pair (BsaI-tailed), each with its annealing Tm and GC |
| wtCodon | Yes | the wild-type codon replaced |
| edgeCase | Yes | set only when the site sits too close to a CDS end for an inner pair: the single spanning primer to use and which outer it replaces. Null otherwise |
| mutCodon | Yes | the mutant codon installed |
| ntChanges | Yes | number of nucleotides changed |
| candidates | Yes | the candidate inner primer pairs (with Tm) |
| ntPosition | Yes | 1-based nt position of the changed codon's first base, counting from the start of the CDS (the engine returns `ntStart + 1`). This said 0-based until 2026-09-02 and it never was — a coordinate convention stated wrongly is worse than one left unstated, because a downstream node acts on it |
design_oligo_plate_orderBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fill | 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 order. Values: rows (Rows (A1, A2, A3 …)), columns (Columns (A1, B1, C1 …)), explicit (Explicitly entered). | rows |
| mixed | 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. | |
| names | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| format | No | wells per plate. Values: 96 (96 well), 384 (384 well). | |
| oligos | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| plate_name | No | the plate's name, which becomes the worksheet's name. Several plates get ' (2)', ' (3)' appended. | Plate 1 |
| pad_to_capacity | No | write every unused well as the supplier's blank-name, blank-sequence row rather than ending the sheet short. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| tsv | Yes | the FIRST plate as tab-delimited text, in the column shape the loading direction requires — the shape the supplier's own paste box accepts verbatim. Several plates means several sheets: read `sheets` for the rest |
| sheets | Yes | one entry per PLATE: its name, its grid, how many wells it fills against the plate's capacity, and every laid-out well |
| columns | Yes | the header row this order was written with, which is the two-vs-three column rule the loading direction decided |
| reading | Yes | what the order is, generated from the laid-out plates rather than from the request |
| refused | Yes | every oligo left OUT, with the reason. Never empty-because-nothing-was-checked: an order that is quietly short is one the user pays a supplier for |
| wellNote | Yes | why the well labels are written unpadded, which is a collision in the supplier's own form rather than our choice |
| plateCount | Yes | how many plates the set needed. Branch a workflow on this rather than re-deriving it |
design_overhang_setARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| size | No | how many junctions the assembly needs (parts + 1 for a circular construct, counted as junctions). | |
| fixed | No | junctions you cannot change, such as a destination vector's own overhangs. They are never considered for replacement and are counted inside `size`. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzyme | No | the Type-IIS enzyme the reaction uses, which picks that enzyme's own measured matrix when one exists. Only applies when dataset is not given. | |
| dataset | No | 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, Golden Gate cycling (4 nt)), BbsI-HF (BbsI-HF, Golden Gate cycling (4 nt)), SapI (SapI, Golden Gate cycling (3 nt)), T4-01h-25C (T4 DNA ligase, 1 h at 25 C (4 nt)), T4-01h-37C (T4 DNA ligase, 1 h at 37 C (4 nt)), T4-18h-25C (T4 DNA ligase, 18 h at 25 C (4 nt)), T4-18h-37C (T4 DNA ligase, 18 h at 37 C (4 nt)). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| start_from | 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. Wire `golden_gate_assemble.overhangs` here. | |
| candidate_pool | No | how many of the strongest-annealing overhangs the search considers. Higher is a better set and a slower run. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| from | Yes | which starting point won: `greedy` for the built set, `yours` for `start_from` improved in place |
| fixed | Yes | the junctions that were pinned and never replaced |
| dataset | Yes | the measured matrix designed against |
| percent | Yes | the same number as a percentage |
| fidelity | Yes | the designed set's fidelity, 0-1, on the same measured matrix |
| overhangs | Yes | the designed set, pinned junctions first. Wire it into score_overhang_fidelity to see the full per-junction breakdown |
design_padlock_probesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| max_tm | No | highest target melting temperature to accept (exclusive). In °C. | |
| min_tm | 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. | |
| barcode | No | the barcode read out by sequencing. Advanced. | XXXX |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| interval | No | fewest bases between two packed targets. In nt. | |
| variants | 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 blast_csv is set. Advanced. | |
| blast_csv | 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. | |
| arm_length | No | length of each target arm; the target is twice this. In nt. | |
| linker_upstream | No | backbone sequence between the 3' arm and the barcode. Advanced. | LINKERFIRST |
| linker_downstream | No | backbone sequence between the barcode and the 5' arm. Advanced. | LINKERSECOND |
Output Schema
| Name | Required | Description |
|---|---|---|
| packed | Yes | every packed target before the database-mappability filter. Null until `blast_csv` is given |
| padlocks | Yes | the final padlock probes (target found in the database), each with its start, target, full sequence and Tm. Null until `blast_csv` is given: the junction check has not been run |
| explanation | Yes | the derivation chain: conclusion, interpretation and machinery, generated from this run |
| padlockCount | Yes | how many padlock probes survived. Null until `blast_csv` is given, because a 0 would read as none surviving a check that has not been run |
| targetsFasta | Yes | the melting-temperature-passing targets as FASTA, named target_N, for blastn |
design_primer_pairsBInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| task | No | `new` ranks candidate pairs; `existing` keeps the primer you supply and designs its mate. | new |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| gc_max | No | highest primer GC accepted. In %. | |
| gc_min | No | lowest primer GC accepted. In %. | |
| n_pairs | No | how many ranked pairs to return. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| excluded | No | spans no primer may sit on, as find_primer_snps' `excluded` emits them: a list of {start, end}, 0-based and end-exclusive, where start = end is an insertion between two bases. The amplicon may run across them. The panel's Avoid known SNPs. Advanced. | |
| fwd_tail | 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 | No | 5' non-annealing tail added to every reverse primer. Advanced. | |
| target_tm | No | the Tm each primer is scored toward. In °C. | |
| weight_gc | No | scoring weight for the `gc` penalty (0 switches it off). Advanced. | |
| weight_tm | No | scoring weight for the `tm` penalty (0 switches it off). Advanced. | |
| conditions | No | salt, magnesium, dNTP and oligo concentrations plus the salt-correction method the Tm window is measured in. Left unset it is filled from your reaction-conditions settings, as the panel's are. Advanced. | |
| region_end | No | 0-based inclusive end of the region to design within. Advanced. | |
| target_end | No | 0-based inclusive end of the target. Advanced. | |
| weight_end3 | No | scoring weight for the `end3` penalty (0 switches it off). Advanced. | |
| region_start | No | 0-based inclusive start of the region to design within. Unset = the whole template. Advanced. | |
| target_start | No | 0-based inclusive start of a target the amplicon must flank, with no primer on it. Advanced. | |
| tm_window_max | No | highest primer Tm accepted at all. In °C. | |
| tm_window_min | No | lowest primer Tm accepted at all. In °C. | |
| weight_length | No | scoring weight for the `length` penalty (0 switches it off). Advanced. | |
| weight_poly_x | No | scoring weight for the `polyX` penalty (0 switches it off). Advanced. | |
| weight_hairpin | No | scoring weight for the `hairpin` penalty (0 switches it off). Advanced. | |
| weight_tm_pair | No | scoring weight for the `tmPair` penalty (0 switches it off). Advanced. | |
| weight_gc_clamp | No | scoring weight for the `gcClamp` penalty (0 switches it off). Advanced. | |
| weight_self_end | No | scoring weight for the `selfEnd` penalty (0 switches it off). Advanced. | |
| existing_forward | No | with `task: existing`, the forward primer to keep. Only applies when task is existing. | |
| existing_reverse | No | with `task: existing`, the reverse primer to keep. Only applies when task is existing. | |
| product_size_max | No | longest acceptable amplicon. In bp. | |
| product_size_min | No | shortest acceptable amplicon. In bp. | |
| weight_cross_end | No | scoring weight for the `crossEnd` penalty (0 switches it off). Advanced. | |
| weight_di_repeat | No | scoring weight for the `diRepeat` penalty (0 switches it off). Advanced. | |
| primer_length_max | No | longest primer. In nt. | |
| primer_length_min | No | shortest primer. In nt. | |
| weight_mispriming | No | scoring weight for the `mispriming` penalty (0 switches it off). Advanced. | |
| weight_self_dimer | No | scoring weight for the `selfDimer` penalty (0 switches it off). Advanced. | |
| mispriming_library | No | a Primer3 repeat library to screen every primer against. `none` skips the screen. Advanced. | none |
| weight_cross_dimer | No | scoring weight for the `crossDimer` penalty (0 switches it off). Advanced. | |
| weight_specificity | No | scoring weight for the `specificity` penalty (0 switches it off). Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| ta | Yes | the top pair's annealing temperature [°C] |
| pairs | Yes | every returned pair in rank order: score, both primers (sequence, span, Tm, GC), product length, Tm and Ta |
| forward | Yes | the top pair's forward primer (wire into pcr_amplify) |
| reverse | Yes | the top pair's reverse primer |
| pairCount | Yes | how many pairs came back |
| shortfall | Yes | why fewer pairs came back than were asked for; empty when the run was not short |
| productLen | Yes | the top pair's amplicon length [bp] |
design_primersBInspect
Design a forward + reverse primer pair to amplify the subject (pydna primer_design), with Tm, Ta and suggested Taq/Phusion cycling programs.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | minimum primer length (pydna `limit`). In bp. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| target_tm | No | target melting temperature (pydna default 55). In °C. | |
| conditions | 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 back to the nearest-neighbour defaults when there are none. Advanced. | |
| forward_primer | No | supply one primer to design only its mate. Advanced. | |
| reverse_primer | No | supply one primer to design only its mate. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| ta | Yes | suggested annealing temperature [°C] |
| forward | Yes | forward primer 5'→3' (wire into pcr_amplify) |
| program | Yes | suggested Taq cycling program |
| reverse | Yes | reverse primer 5'→3' (wire into pcr_amplify) |
| forwardTm | Yes | forward primer Tm [°C] |
| productTm | Yes | amplicon melting temperature [°C] (Rychlik 1990, at the run's own monovalent salt) — 70% of `ta` on the Taq path |
| reverseTm | Yes | reverse primer Tm [°C] |
| productLen | Yes | amplicon length [bp] |
design_qpcr_assayAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| conditions | 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-conditions settings, and falls back to the nearest-neighbour defaults when there are none. Advanced. | |
| max_poly_x | No | longest run of one base allowed in any oligo (primer3's POLY_X). A long run mispairs by slipping, and for a TaqMan probe a run of four or more Gs quenches the reporter. In nt. Advanced. | |
| region_end | No | 0-based inclusive end. Unset = the whole sequence. Advanced. | |
| max_results | No | how many assays to return, best penalty first. | |
| amplicon_max | 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. | |
| amplicon_min | No | shortest acceptable amplicon. In bp. | |
| probe_max_gc | No | highest acceptable probe GC content. In %. Advanced. | |
| probe_max_tm | No | probes above this Tm are rejected outright. In °C. Advanced. | |
| probe_min_gc | No | lowest acceptable probe GC content. In %. Advanced. | |
| probe_min_tm | No | probes below this Tm are rejected outright. In °C. Advanced. | |
| probe_tm_opt | No | target probe Tm - conventionally ~10 °C above the primers, so the probe is bound before extension reaches it. In °C. | |
| region_start | 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. | |
| primer_max_gc | No | highest acceptable primer GC content. In %. Advanced. | |
| primer_max_tm | No | primers above this Tm are rejected outright. In °C. Advanced. | |
| primer_min_gc | No | lowest acceptable primer GC content. In %. Advanced. | |
| primer_min_tm | No | primers below this Tm are rejected outright, not merely penalised. In °C. Advanced. | |
| primer_tm_opt | No | target primer Tm; the penalty ranks candidates by their distance from it. In °C. | |
| probe_chemistry | 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 over its primers. MGB and Scorpion chemistries are not offered: neither has a published nearest-neighbour parameter set to compute a Tm from. | dna |
| structure_check | 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 that dimerises is the commonest design failure and penalty ranking alone will happily put one first. Off returns null structures and is measurably faster - the check is a dynamic-programming alignment per oligo pair. Advanced. | |
| probe_max_length | No | longest probe considered. In nt. Advanced. | |
| probe_min_length | No | shortest probe considered. In nt. Advanced. | |
| probe_opt_length | No | probe length the penalty prefers. In nt. Advanced. | |
| primer_max_length | No | longest primer considered; primer3's own ceiling is 36. In nt. Advanced. | |
| primer_min_length | No | shortest primer considered. In nt. Advanced. | |
| primer_opt_length | No | primer length the penalty prefers. In nt. Advanced. | |
| probe_tm_offset_min | 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. | |
| probe_locked_positions | 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, because McTigue et al. (2004) measured one locked base per nearest neighbour and none at a duplex end - a position that breaks either rule is refused by name rather than silently dropped. Only applies when probe_chemistry is lna. |
Output Schema
| Name | Required | Description |
|---|---|---|
| best | Yes | the best-penalty assay |
| count | Yes | how many assays were found |
| probe | Yes | the best assay's probe |
| assays | Yes | the ranked assays |
| offset | Yes | where the designed-in stretch starts in the record: add it to every position above for record coordinates. 0 unless a region was given |
| forward | Yes | the best assay's forward primer |
| reverse | Yes | the best assay's reverse primer |
| conditions | Yes | the buffer every Tm in this design was measured in - salt, magnesium, dNTPs, oligo concentration, the salt-correction method and any additives - or a note saying none were supplied |
| probe_ordered | Yes | the best assay's probe as it must be ORDERED: plain DNA, or the locked-base notation (`GTCGLAAC`) when the probe was designed as LNA |
design_rbsAInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| cds | No | the CDS starting at its start codon; unset = the open record's sequence. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| upstream | No | upstream context 5' of the UTR (engine default when unset). Advanced. | |
| target_strength | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| sd | Yes | the Shine-Dalgarno core |
| utr | Yes | the designed 5'UTR |
| full | Yes | UTR + CDS |
| dgTotal | Yes | the predicted total free energy of translation initiation (ΔG_total, kcal/mol) for the designed site; null when the model could not fold it |
| spacing | Yes | SD→start spacing |
| onTarget | Yes | whether the target strength was reachable |
| relStrength | Yes | achieved relative strength |
| achievableMax | Yes | the strongest relative strength any candidate site reached in this search, which bounds what a target above it can get |
| achievableMin | Yes | the weakest relative strength any candidate site reached in this search, which bounds what a target below it can get |
design_saturation_primersBInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| k | No | potassium concentration. In mM. Advanced. | |
| mg | No | magnesium concentration — the term the Owczarzy corrections are most sensitive to. In mM. Advanced. | |
| na | No | sodium concentration the salt correction is computed for. In mM. Advanced. | |
| cds | Yes | the CDS nucleotide sequence, in frame from the start codon (length must be a multiple of 3). | |
| dntp | No | total dNTP concentration, which chelates magnesium and so lowers the effective Mg²⁺. In mM. Advanced. | |
| tris | No | Tris concentration. In mM. Advanced. | |
| dnac1 | No | the higher-concentration strand (the primer, in a large excess). In nM. Advanced. | |
| dnac2 | No | the lower-concentration strand (the template). In nM. Advanced. | |
| sites | Yes | the saturation sites, comma- or space-separated, as [WT][pos]X — e.g. "V2X, K107X". 1-based residue positions. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| solver | 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 every allowed length at every allowed start and scores every geometrically valid pair — hundreds of thousands per site, seconds rather than milliseconds, and it reports what it searched. Values: fast (Fast approximation), exhaustive (Exhaustive search). | fast |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| precision | No | decimal places the reported Tm is rounded to. In dp. Advanced. | |
| oligo_prefix | No | prefix for the designed oligo names. Advanced. | ssm |
| five_end_flank | No | explicit 5' flanking sequence — only for a free-standing gene with no plasmid open, and then the 3' flank is required too. Advanced. | |
| forward_primer | 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). | |
| max_gc_content | No | highest GC accepted. In %. Advanced. | |
| min_gc_content | No | lowest primer GC accepted before a primer is flagged out of range. In %. Advanced. | |
| reverse_primer | 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). | |
| max_primer_size | No | longest whole primer. In nt. Advanced. | |
| min_primer_size | No | shortest whole primer. In nt. Advanced. | |
| salt_correction | No | salt-correction method, in Biopython's `saltcorr` order. Values: No (None), Schildkraut_1965 (Schildkraut & Lifson 1965 (16.6 · log[Na⁺])), Wetmur_1991 (Wetmur 1991 (16.6 · log[Na⁺/(1 + 0.7 · Na⁺)])), SantaLucia_1996 (SantaLucia 1996 (12.5 · log[Na⁺])), SantaLucia_1998 (SantaLucia 1998 (11.7 · log[Na⁺])), SantaLucia_DeltaS_1998 (SantaLucia 1998, entropy (corrects ΔS, not Tm)), Owczarzy_2004 (Owczarzy 2004 (GC-dependent, corrects 1/Tm)), Owczarzy_2008 (Owczarzy 2008 (Mg²⁺ decision tree, dNTP-corrected)). Advanced. | Owczarzy_2004 |
| three_end_flank | No | explicit 3' flanking sequence, the partner of `five_end_flank`. Advanced. | |
| degenerate_codon | No | the degenerate codon installed at every site (NNK is the common 32-codon choice). | NNK |
| max_overlap_size | No | longest overlap. Upstream's scan stops two short of this (a reproduced quirk, see the port header). In nt. Advanced. | |
| min_overlap_size | No | shortest shared overlap. In nt. Advanced. | |
| gc_content_weight | No | score weight on GC overflow. Upstream's default is 0, and its GC term counts G twice and never counts C (a reproduced bug, see the port header) — raising this weight makes that quirk observable. Advanced. | |
| max_five_end_size | No | longest 5' arm before the mutated codon. In nt. Only applies when solver is exhaustive. Advanced. | |
| min_five_end_size | No | shortest 5' arm before the mutated codon. In nt. Advanced. | |
| max_three_end_size | No | longest 3' arm beyond the mutated codon. Bounds the search area and discards candidates whose 3' arm overruns it. In nt. Only applies when solver is exhaustive. Advanced. | |
| min_three_end_size | No | shortest 3' arm beyond the mutated codon. In nt. Advanced. | |
| overlap_temp_range | No | width of the overlap Tm window. In °C. Advanced. | |
| overlap_temp_weight | No | score weight on overlap Tm deviation. Advanced. | |
| three_end_temp_range | No | width of the 3'-end Tm window scanned around each candidate temperature. In °C. Advanced. | |
| three_end_size_weight | No | score weight on 3'-end length deviation. Advanced. | |
| three_end_temp_weight | No | score weight on 3'-end Tm deviation. Advanced. | |
| max_overlap_temperature | No | highest overlap Tm allowed. In °C. | |
| min_overlap_temperature | No | lowest overlap Tm the reaction may settle on. In °C. | |
| overlap_temp_range_step | No | step between overlap temperatures tried. In °C. Advanced. | |
| exclude_flanking_primers | No | take the 3' Tm window from the explicit min/max above instead of from the flanking pair's own Tm. Advanced. | |
| compute_hairpin_homodimer | No | add the hairpin/homodimer/heterodimer penalty to the score (roughly doubles the run; off upstream). Advanced. | |
| max_three_end_temperature | No | highest 3'-end Tm allowed. In °C. | |
| min_three_end_temperature | 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. | |
| three_end_temp_range_step | No | step between 3'-end temperatures tried. In °C. Advanced. | |
| hairpin_temperature_weight | No | score weight on hairpin Tm. Only applies when compute_hairpin_homodimer is true. Advanced. | |
| primer_dimer_temperature_weight | No | score weight on homo/heterodimer Tm. Only applies when compute_hairpin_homodimer is true. Advanced. | |
| separate_forward_reverse_temperatures | No | optimise the forward and reverse 3' temperatures independently. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| pairs | Yes | one designed forward/reverse pair per site, with its overlap, temperatures, GC and in-range flags |
| search | Yes | what the solver actually searched: candidates enumerated and kept, pairs scored, temperature combinations tried. Null for the fast solver, which enumerates nothing |
| siteCount | Yes | sites requested |
| foundCount | Yes | sites the solver found a pair for (< siteCount means the parameters were too tight for some) |
| fullSequence | Yes | the construct the design spans, flanking primer to flanking primer |
| forwardTemperature | Yes | reaction-level forward 3'-end Tm |
| overlapTemperature | Yes | the ONE overlap Tm the whole reaction settled on |
| reverseTemperature | Yes | reaction-level reverse 3'-end Tm |
design_sequencing_primersAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| overlap | 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 stated rather than dressed as a figure. In bp. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| dead_zone | 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 both directions. In bp. Advanced. | |
| target_tm | No | target melting temperature for each primer in the walk. In °C. Advanced. | |
| min_length | No | shortest acceptable primer. In bp. Advanced. | |
| region_end | No | 0-based inclusive end of the region to read. Unset = the whole template. Advanced. | |
| read_length | 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), which is the cautious end of a published range rather than a round number. In bp. | |
| both_strands | 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 | No | 0-based inclusive start of the region to read. Unset = the whole template. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| gaps | Yes | stretches no read reaches - empty means the region is fully read |
| used | Yes | the parameters the plan was actually built under, so a readout never restates them |
| reads | Yes | one entry per primer in the walk: name (F1, R1, ...), sequence, strand, and the stretch it is expected to read |
| primers | Yes | just the primer sequences, in walk order, for ordering |
| skipped | Yes | anchors where no primer could be designed, each with the reason - never a silently short walk |
| complete | Yes | true when every base of the region is read at least once |
| coverage | Yes | every stretch of the region, contiguous and in order, with its depth |
| authority | Yes | the published source the read-length and dead-zone defaults come from |
| readCount | Yes | how many primers the walk needs |
| doubleStranded | Yes | true when every base is read from both directions |
| singleStranded | Yes | stretches read from one strand only, when both were asked for |
design_split_sitesBRead-onlyInspect
Decide where to CUT one sequence into Golden Gate fragments, optimising the split positions and the overhangs they create together.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| traces | 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. | |
| dataset | 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 (4 nt)), Esp3I (Esp3I, Golden Gate cycling (4 nt)), BbsI-HF (BbsI-HF, Golden Gate cycling (4 nt)), SapI (SapI, Golden Gate cycling (3 nt)), T4-01h-25C (T4 DNA ligase, 1 h at 25 C (4 nt)), T4-01h-37C (T4 DNA ligase, 1 h at 37 C (4 nt)), T4-18h-25C (T4 DNA ligase, 18 h at 25 C (4 nt)), T4-18h-37C (T4 DNA ligase, 18 h at 37 C (4 nt)). Advanced. | T4-18h-37C |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the sequence to fragment, in one piece. Leave it empty to fragment the open record. | |
| fragments | No | pin the number of fragments instead of letting the search choose. Leave empty to take whatever the length window allows. | |
| exclude_to | No | end of that span, exclusive. Only applies when exclude_from is set. Advanced. | |
| max_length | No | longest allowed fragment, in bases — the vendor's upper limit, or the length you can sequence in one read. | |
| min_length | No | shortest allowed fragment, in bases — usually what your synthesis vendor will accept. | |
| exclude_from | No | start of a span no cut may fall in — a feature you need kept intact. Use with exclude_to. Advanced. | |
| alien_overhangs | No | junctions already committed elsewhere in the assembly (a fixed vector's own ends), which this set must not collide with. Advanced. | |
| fidelity_weight | No | exponent on the running FIDELITY — raise it to favour junctions that ligate to the right partner rather than a mismatched one. Advanced. | |
| efficiency_weight | 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. Advanced. | |
| max_overhang_identity | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| score | Yes | the objective for the winning arrangement: net efficiency^w x net fidelity^w |
| breaks | Yes | the winning arrangement's cut positions, in reading order |
| report | Yes | the whole result, every arrangement in full |
| dataset | Yes | the measured matrix actually scored against |
| fragments | Yes | the fragments to order: sequence, span, length and the overhang at each end. Consecutive fragments overlap by exactly the four-base junction |
| overhangs | Yes | the junctions the winning arrangement creates — wire this straight into score_overhang_fidelity to grade the set it chose |
| candidates | Yes | how many arrangements were feasible at all under these constraints |
| alternatives | Yes | the other ranked arrangements, each with its own breaks, score and junctions — the best is rarely the only acceptable one |
| net_fidelity | Yes | net fidelity across every junction, 0-1 |
| fragment_count | Yes | how many fragments the winning arrangement needs |
| net_efficiency | Yes | net ligation efficiency across every junction, 0-1 |
design_xenium_probesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| spacing | No | fewest bases between two kept targets. In bp. | |
| tm_rule | 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. | either |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| blast_csv | 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 homology. | |
| junctions | No | ligation-junction dinucleotides to accept, from 10x's empirical ligase preferences; 10x strongly recommends avoiding the nonpreferred four. | preferred and neutral |
| max_g_run | No | longest run of G the probe may carry; 10x: avoid five or more. Advanced. | |
| arm_length | 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. | |
| max_arm_tm | No | highest Tm of each arm (inclusive). In °C. | |
| min_arm_tm | No | lowest Tm of each arm (inclusive). In °C. | |
| prefer_cds | No | rank targets inside the subject's CDS feature before the untranslated regions, as 10x advises where possible. | |
| max_full_tm | No | highest Tm of the whole target (inclusive). In °C. | |
| min_full_tm | No | lowest Tm of the whole target (inclusive). In °C. | |
| min_mismatches | 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. | |
| gene_accessions | 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. | |
| probes_per_gene | No | targets to keep; 10x's predesigned panels use eight per gene. |
Output Schema
| Name | Required | Description |
|---|---|---|
| probes | Yes | the kept targets, each with its 0-based start, target (mRNA sense), probe (its reverse complement), arm and full-length Tm, junction and its class, and the fewest off-target mismatches. Null until `blast_csv` is given |
| stages | Yes | what each rule took in and kept, in order, with the reason a skipped check did not run |
| probeCount | Yes | how many targets were kept. Null until `blast_csv` is given |
| explanation | Yes | the derivation chain: conclusion, interpretation and machinery, generated from this run |
| targetsFasta | Yes | the targets that pass the Tm, junction and G-run rules as FASTA, named xenium_<1-based start>, for blastn |
detect_trace_indelARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| table | 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. | 3730pop7 |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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 project-specific, so a template ships this unset. | |
| breakpoint_scan | No | skip the search and measure the indel at this scan position on the x axis. -1 searches for it. | |
| quality_value_reading | 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 fires. | corrected |
Output Schema
| Name | Required | Description |
|---|---|---|
| found | Yes | whether a heterozygous indel was detected. Wire it into a gate |
| report | Yes | the whole finding, including the size in scans and the stutter verdict |
| longAllele | Yes | the allele with the extra bases, from the breakpoint on. N marks a position the deconvolution would not commit to, not a low-quality base |
| qualityJump | Yes | the drop in quality values across the breakpoint. It must exceed 7 for a position to be considered at all, so this is what a negative answer is checkable against |
| shortAllele | Yes | the allele without them, from the breakpoint on |
| sizeInBases | Yes | how many bases the longer allele carries that the shorter one does not |
| startsAtBase | Yes | the 1-based base the split starts at, or 0 when none was found |
differential_expressionCRead-onlyInspect
Differential expression from raw RNA-seq read counts, by one of the three standard count models.
| Name | Required | Description | Default |
|---|---|---|---|
| name | 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. | |
| test | No | Wald: one coefficient or contrast. LRT: the full design against `reduced`, testing every removed term at once. Only applies when method is DESeq2. | Wald |
| useT | 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 only. Only applies when method is DESeq2. | |
| alpha | No | the target FDR: the summary counts genes below this adjusted p, and DESeq2's independent filtering maximizes rejections at it. | |
| blind | No | fit the transformation's dispersion trend under ~ 1, blind to the design (DESeq2's default, for quality assessment); off reuses the fitted design and trend, for downstream use when large differences between groups are expected. Only applies when method is DESeq2. | |
| minmu | 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 (zinbwave's vignette). Only applies when method is DESeq2. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| counts | 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. | |
| design | No | the design formula over the sample table's columns, the variable of interest last (e.g. '~ batch + condition'). | ~ condition |
| method | 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). | DESeq2 |
| pcaTop | No | plotPCA's ntop: the PCA uses this many genes with the largest variance of the transformed values. Only applies when method is DESeq2. | |
| sfType | 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 (iterate, when every gene has a zero). Only applies when method is DESeq2. | ratio |
| shrink | No | shrink the reported coefficient's or contrast's log2 fold changes toward zero where the counts cannot support them (DESeq2 lfcShrink), for ranking and plotting by effect size; p-values stay the unshrunken test's. apeglm: adaptive Cauchy prior, posterior mode (a coefficient only). ashr: mixture-of-normals prior, posterior mean. normal: DESeq2's original zero-centred Normal prior (Wald only), a contrast on the expanded model matrix. With lfcThreshold, apeglm and ashr give s-values of a false sign or a fold change inside the threshold, and normal re-tests the shrunken fit. Only applies when method is DESeq2. | none |
| fitType | 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 gene-wise estimates, or glmGamPoi (gene-wise maximum likelihood by glmGamPoi, a local-median trend and quasi-likelihood shrinkage; with test LRT the p-values are glmGamPoi's quasi-likelihood F test; no outlier replacement, minmu 1e-6, no observation weights). Only applies when method is DESeq2. | parametric |
| reduced | No | the reduced design for the likelihood-ratio test. Only applies when method is DESeq2. | |
| samples | 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. | |
| weights | 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 gene's weights by their largest and uses them in the base means, the dispersion likelihoods (samples at or below 0.01 leave the Cox-Reid term), the GLM and its tests. Only applies when method is DESeq2. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| contrast | 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. | |
| minCount | 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. | |
| pcaGroup | No | plotPCA's intgroup: the sample-table variables, separated by commas, that colour the samples (joined with ':' when more than one); empty is the factor of the reported comparison. Only applies when method is DESeq2. | |
| betaPrior | 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 instead of `shrink`. Only applies when method is DESeq2. | |
| reference | No | reference level per factor, 'variable=level' separated by commas; a factor not named takes its alphabetically first level, as R does. | |
| transform | No | the count transformation the sample-level checks (PCA, sample distances) run on: vst (DESeq2's variance stabilizing transformation, the trend fitted on 1,000 genes; with fewer than 1,000 genes above a mean of 5 use VST), VST (varianceStabilizingTransformation, every gene), rlog (regularized log, a per-gene ridge fit, slow above ~30 samples) or normTransform (log2 of normalized count + 1, no stabilization). none skips the checks. Only applies when method is DESeq2. | vst |
| avgTxLength | 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, times median-of-ratios size factors), correcting for changes in transcript usage between samples. Only applies when method is DESeq2. | |
| cooksCutoff | No | the Cook's distance cutoff; empty is DESeq2's F(0.99; p, m - p). Only applies when method is DESeq2. | |
| cooksFilter | No | set the p-value of genes with a Cook's-distance outlier to NA. Only applies when method is DESeq2. | |
| filterByExpr | 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. | |
| lfcThreshold | No | test |log2 fold change| against this threshold instead of 0. Only applies when method is DESeq2. | |
| altHypothesis | No | which side of the threshold is the alternative. Only applies when method is DESeq2. | greaterAbs |
| minTotalCount | No | filterByExpr: the total count a gene needs across all samples. Only applies when method is edgeR-QL or limma-voom. | |
| pAdjustMethod | No | multiple-testing adjustment across genes (R `p.adjust`). | BH |
| independentFiltering | No | drop low-mean genes from the adjustment when that gains rejections at `alpha`. Only applies when method is DESeq2. | |
| minReplicatesForReplace | No | samples per group from which outlier counts are replaced and the gene refitted, instead of flagged. Only applies when method is DESeq2. |
Output Schema
| Name | Required | Description |
|---|---|---|
| genes | Yes | one row per gene: log2FoldChange, stat (DESeq2 Wald or LRT, edgeR F, voom moderated t), pvalue, padj, why padj is NA, the normalized counts per sample; DESeq2 adds baseMean, lfcSE, the gene-wise, fitted and final dispersions, whether it was refitted and with `shrink` the shrunken fold change, its SE and s-value (normal with lfcThreshold: the shrunken fit's p-value and padj); edgeR and voom add logCPM, the raw, prior and posterior variance (edgeR's QL dispersion) and the total df, and voom the B-statistic |
| maPlot | Yes | log2 fold change (shrunken, with `shrink`) against mean normalized count (DESeq2) or average log2 CPM (edgeR, voom), significant genes apart |
| summary | Yes | genes up and down at alpha and tested, with the method's own fit: DESeq2's outliers, low counts, filter threshold, size factors, dispersion trend and shrinkage prior; edgeR's common and average QL dispersion and prior df; voom's span and prior variance; the filterByExpr cutoffs and library sizes |
| upGenes | Yes | significant genes with positive log2 fold change, one per line |
| volcano | Yes | -log10 p against log2 fold change, significant genes apart |
| downGenes | Yes | significant genes with negative log2 fold change, one per line |
| samplePca | Yes | DESeq2 runs only (null under edgeR and voom): plotPCA on the transformed counts (`transform`, `blind`): PC2 against PC1 per sample, one series per `pcaGroup` level, each axis labelled with its share of the variance |
| meanCounts | Yes | DESeq2 runs only (empty under edgeR and voom): every tested gene with its mean normalized count (baseMean), 'gene value' per line: the gene weights for a Wallenius-weighted over-representation test, which corrects for the extra power to call well-counted genes |
| rankedList | Yes | tested genes by their test statistic, decreasing: DESeq2's Wald statistic, voom's moderated t, or edgeR's signed square root of F (a t with the same df): the ranked list for GSEA |
| testedGenes | Yes | every gene with an adjusted p-value, one per line: the background (universe) for over-representation analysis |
| dispersionPlot | Yes | DESeq2: gene-wise, fitted and final dispersions against mean count. edgeR: quarter-root raw, squeezed and trend QL dispersions against average log2 CPM (plotQLDisp). voom: sqrt standard deviation against log2 count size, with the lowess trend that sets the weights |
| sampleDistances | Yes | DESeq2 runs only (null under edgeR and voom): the sample checks as data: the transformation and its trend, the PCA genes, percentVar, PC1 and PC2 per sample, the sample-to-sample Euclidean distance matrix over every gene and its complete-linkage clustering (leaf order, merges, heights), as the vignette's heatmap draws it; or why the checks could not run |
| significantGenes | Yes | genes with padj below alpha, one per line: the gene list for over-representation analysis |
digest_fragmentsAInspect
Digest the subject with the given enzymes into real fragments (sequence + both overhangs).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| fragment_index | No | which fragment to emit as the downstream record (0-based, in cut order). |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | number of fragments |
| record | Yes | the selected fragment as a linear record |
| lengths | Yes | fragment lengths in cut order |
| fragments | Yes | every fragment (sequence + left/right overhang + enzyme) |
| parentSpan | Yes | where the emitted fragment sat on the parent, [start, end). A start above the end spans the origin |
digest_reaction_conditionsBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | 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 | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| buffer | Yes | the recommended NEBuffer, or null when every buffer is starred or at 0% for one of the enzymes |
| buffers | Yes | every NEBuffer scored, best first: worst percent, star-active enzymes, usable, per-enzyme activity |
| unknown | Yes | names NEB does not sell, so no conditions exist for them |
| cofactors | Yes | cofactors the reaction requires (SAM, ATP), from REBASE |
| singleTube | Yes | true when one buffer AND one temperature serve every enzyme |
| temperaturesC | Yes | incubation temperatures required, ascending; more than one means more than one step |
| heatInactivation | Yes | whether the tube can be heat-killed, each product's NEB step (temperature, minutes), and the products that need a column or gel cleanup instead |
discover_annotation_contradictionsBRead-onlyInspect
Find the signal peptides or transmembrane segments in reviewed human UniProt that a sequence predictor contradicts.
| Name | Required | Description | Default |
|---|---|---|---|
| alpha | No | false discovery rate at which an annotation is called contradicted. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| feature | No | which annotation to test: signal peptides or transmembrane segments. Values: signal (Signal peptides), transmembrane (Transmembrane segments). | signal |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| decoding | 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-Viterbi), optimal-accuracy (Optimal accuracy). Only applies when feature is transmembrane. Advanced. | viterbi |
| predictor | 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 twenty networks per protein, so it is far slower than the matrix). Values: von-heijne (von Heijne matrix), deepsig (DeepSig). Only applies when feature is signal. | von-heijne |
| correction | 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 (Benjamini–Hochberg), BY (Benjamini–Yekutieli). | BH |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many annotations are contradicted |
| result | Yes | the full result, every tested annotation included |
| selfCheck | Yes | half the experimental features tested against the other half: raw p ≤ α should be near α of them, and FDR calls near none |
| contradicted | Yes | the annotations contradicted at the chosen false discovery rate: accession, gene, span, statistic, p and q |
discover_codon_outliersARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| alpha | No | false discovery rate at which a gene is reported as an outlier. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| alt_init | 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. | |
| sequences | 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). | |
| correction | No | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). | BH |
| file_codes | 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 differently. Advanced. | |
| min_codons | 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. | |
| pool_files | 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. | |
| genetic_code | 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 Mitochondrial), 4 (4 · Mold Mitochondrial, Protozoan Mitochondrial, Coelenterate Mitochondrial, Mycoplasma, Spiroplasma), 5 (5 · Invertebrate Mitochondrial), 6 (6 · Ciliate Nuclear, Dasycladacean Nuclear, Hexamita Nuclear), 9 (9 · Echinoderm Mitochondrial, Flatworm Mitochondrial), 10 (10 · Euplotid Nuclear), 11 (11 · Bacterial, Archaeal and Plant Plastid), 12 (12 · Alternative Yeast Nuclear), 13 (13 · Ascidian Mitochondrial), 14 (14 · Alternative Flatworm Mitochondrial), 15 (15 · Blepharisma Macronuclear), 16 (16 · Chlorophycean Mitochondrial), 21 (21 · Trematode Mitochondrial), 22 (22 · Scenedesmus obliquus Mitochondrial), 23 (23 · Thraustochytrium Mitochondrial), 24 (24 · Rhabdopleuridae Mitochondrial), 25 (25 · Candidate Division SR1 and Gracilibacteria), 26 (26 · Pachysolen tannophilus Nuclear), 27 (27 · Karyorelict Nuclear), 28 (28 · Condylostoma Nuclear), 29 (29 · Mesodinium Nuclear), 30 (30 · Peritrich Nuclear), 31 (31 · Blastocrithidia Nuclear), 32 (32 · Balanophoraceae Plastid), 33 (33 · Cephalodiscidae Mitochondrial). |
Output Schema
| Name | Required | Description |
|---|---|---|
| genes | Yes | every gene scored: codons, B, MILC, G, degrees of freedom, p and q |
| result | Yes | the full result, with the settings that produced it |
| skipped | Yes | genes left out as too short, with their codon counts |
| outliers | Yes | genes at q ≤ alpha, largest MILC first |
| outlierCount | Yes | how many genes were called outliers |
discover_flag_ratesBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| seed | 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. | |
| alpha | No | false discovery rate at which a record counts towards a flag's rate. | |
| flags | No | which statistics to run. Empty runs all seven. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| shuffles | 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. | |
| sequences | No | the corpus: wire upstream records here, or list library document names. Each is one record of the sweep. | |
| shuffle_k | No | k-let size the shuffles preserve. 2 holds every dinucleotide count, which is what all three statistics read. | |
| correction | No | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). | BH |
| include_subject | No | also test the node's subject (the open or wired record). |
Output Schema
| Name | Required | Description |
|---|---|---|
| hits | Yes | every record whose statistic beat chance, smallest p first |
| rates | Yes | per statistic: records tested, records above chance, the rate and its exact 95% interval |
| sweep | Yes | the full result, including the records tested |
| tests | Yes | every (record, statistic) test: the observed statistic, the shuffles' mean, p, q and the Monte Carlo interval |
| hitCount | Yes | how many (record, statistic) tests were called |
| nullModel | Yes | the null the p-values stand on, stated with every run |
discover_gene_tree_discordanceBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| seed | 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. | |
| alpha | No | false discovery rate at which a gene counts as rejecting the species tree. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| sh_form | 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 the replicates are symmetric. Values: published (Published (from the best tree)), phangorn (phangorn (from the worst tree)). Advanced. | published |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| alignments | 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. | |
| correction | No | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). | BH |
| replicates | 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). | |
| species_tree | Yes | the species tree in Newick, tips named as the alignments' records. Rooted or not; it is tested unrooted. | |
| gamma_categories | No | discrete Gamma rate categories; 1 fits no rate variation among sites. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| genes | Yes | every gene: sites, each candidate tree's log-likelihood and SH p, the species tree's p and q |
| sweep | Yes | the full result |
| rejected | Yes | genes whose alignment rejects the species tree at the chosen false discovery rate |
| discordant | Yes | genes whose best tree is not the species tree, rejected or not |
| alternatives | Yes | each alternative tree some gene prefers, with how many prefer it and how many of those reject the species tree |
discover_reference_concordanceBRead-onlyInspect
Ask whether a reference-gene stability ranking holds across conditions, and which candidate genes rank well everywhere rather than in one tissue or treatment.
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | seed for the shuffles. Each permutation draws from its own stream, so one can be re-run alone. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cq_table | 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 | No | shuffles of the ranks within each condition. The smallest p is 1 / (permutations + 1). |
Output Schema
| Name | Required | Description |
|---|---|---|
| p | Yes | Monte Carlo p of W against within-condition shuffles |
| w | Yes | Kendall's coefficient of concordance across conditions |
| genes | Yes | every gene, most stable on average first: its rank in each condition, mean rank, best and worst |
| result | Yes | the full result |
| nullModel | Yes | the null, stated with every run |
| conditions | Yes | each condition's geNorm order with M |
discover_reference_stabilityBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| alpha | No | false discovery rate at which a candidate is called more variable, or steadier, than its peers. | |
| genes | Yes | the candidate reference genes, as current HGNC symbols (GAPD is GAPDH). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| tissues | No | GTEx tissue names to compare across, three or more; empty means all 54. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| correction | No | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). | BH |
| neighbours | No | how many genes nearest in mean expression each candidate is ranked among. The smallest p it can give is 1 / (neighbours + 1). | |
| pseudocount | No | added to TPM before the logarithm, so a tissue with no expression has one. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes | the full result |
| stable | Yes | the candidates steadier than their expression peers at the chosen false discovery rate |
| rankers | Yes | geNorm M, NormFinder, BestKeeper, comparative ΔCt and the RefFinder consensus over the candidates |
| unstable | Yes | the candidates more variable across tissues than their expression peers at the chosen false discovery rate |
| candidates | Yes | every candidate's mean and SD of log2 expression, the expression band of its peers, its percentile among them and both p and q |
discover_site_avoidanceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | seed for the shuffles, so a run reproduces. Only applies when null_model is shuffle. Advanced. | |
| alpha | No | false discovery rate at which a site is reported avoided or enriched. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| shuffles | No | shuffles per record. The smallest p the null can give is 1 / (shuffles + 1). Only applies when null_model is shuffle. | |
| positions | No | also return every occurrence's coordinate and strand, for drawing on a map. Advanced. | |
| sequences | No | the corpus: wire upstream records here, or list library document names. Each is one record of the sweep. | |
| shuffle_k | 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. | |
| correction | 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 (Benjamini–Yekutieli). | BH |
| null_model | 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: order0 (Base composition (order-0)), shuffle (k-let shuffles (uShuffle)), maximal (Maximal-order Markov (R'MES)). | order0 |
| include_subject | No | also sweep the node's subject (the open or wired record). | |
| min_site_length | No | shortest recognition site swept. In bp. |
Output Schema
| Name | Required | Description |
|---|---|---|
| sweep | Yes | the full result, including the records swept and the degenerate sites skipped |
| tests | Yes | every (record, site) test: observed, expected, ratio, both tails and both q-values; under the maximal-order null also the R'MES score z and its variance |
| avoided | Yes | tests whose low-tail q is at or below alpha, most extreme ratio first |
| enriched | Yes | tests whose high-tail q is at or below alpha, most extreme ratio first |
| nullModel | Yes | the null the p-values stand on, stated with every run |
| correction | Yes | the multiple-testing correction that ran, and why it is valid |
| avoidedCount | Yes | how many (record, site) tests were called avoided |
| enrichedCount | Yes | how many (record, site) tests were called enriched |
discover_target_validationARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| gene | Yes | the gene under test, as the tables spell it (HGNC symbol for the bundled corpus). | |
| alpha | No | the hypothesis passes when the product of e-values exceeds 1/α. | |
| kappa | No | κ of the p-to-e calibrator κ·p^(κ−1); POPPER's default is 0.5. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| tables | 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 predicts, `greater` (default) or `less`. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| tests | Yes | each test: score, genes at or beyond, p, e and running product |
| jointP | Yes | the product's share among every gene's product |
| result | Yes | the full result |
| combined | Yes | the product of the calibrated e-values |
| rejected | Yes | whether the product of e-values exceeded 1/α |
| nullModel | Yes | the null, stated with every run |
discover_tree_incongruenceARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| loci | 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. | |
| seed | No | seed for the column deals. Each permutation draws from its own stream, so one can be re-run alone. Advanced. | |
| alpha | No | false discovery rate at which a locus is called. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| correction | No | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). | BH |
| permutations | No | random deals of the columns per test. The smallest p is 1 / (permutations + 1), which bounds how small a corrected q can get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| loci | Yes | per locus: its length, the rest's, D, the permutations' mean D, p, q and whether it is called |
| called | Yes | the loci called at q ≤ alpha |
| global | Yes | the test over every locus at once: D, its null, p |
| result | Yes | the full result |
| nullModel | Yes | the null and the search, stated with every run |
domesticate_partAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| table | 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 come from one someone built or fetched. Leave unset and the active table is used. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzyme | No | the Type-IIS enzyme whose sites must go. | BsaI |
| cds_end | Yes | 0-based end of the coding sequence (exclusive). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the part to domesticate — wire a record, name a library document, or leave unset to use the open record. | |
| cds_start | Yes | 0-based start of the coding sequence within the part. | |
| table_tsv | 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 a typed one is indistinguishable from a real one in the result. TSV: codon<TAB>count. Advanced. | |
| cds_strand | No | 1 for the top strand, -1 for the bottom. Values: 1 (Top strand), -1 (Bottom strand). |
Output Schema
| Name | Required | Description |
|---|---|---|
| fixes | Yes | one line per synonymous swap, as the engine logs it |
| sequence | Yes | the part with every reachable internal site recoded |
| fixedCount | Yes | how many internal occurrences were actually fixed |
| outsideCds | Yes | internal sites the CDS does NOT cover — left untouched, and yours to solve another way |
dot_plotBRead-onlyInspect
Self-similarity or pairwise comparison of the subject as a dot plot — repeats, inversions and shared regions.
| Name | Required | Description | Default |
|---|---|---|---|
| step | No | residues between window starts (seqinr `wstep`). 1 compares every position. Only applies when engine is window. Advanced. | |
| other | No | the sequence to compare against — wire a record or name a library document; leave unset for self-vs-self. | |
| shift | No | phase offset applied to the second sequence's windows (seqinr `shift`). Only applies when engine is window. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| dedupe | 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. | |
| engine | 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)), matrix (Substitution matrix (dotmatcher)). | word |
| matrix | 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 (protein)). Only applies when engine is matrix. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| max_cells | 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. | |
| threshold | No | score a window must reach (EMBOSS default 23). Only applies when engine is matrix. Advanced. | |
| word_size | No | k for the k-mer engine, or the window length for the other two. In bp. | |
| nucleotide | No | nucleotide rather than protein. Advanced. | |
| matrix_text | No | a custom scoring matrix in EMBOSS/NCBI format, overriding `matrix`. Only applies when engine is matrix. Advanced. | |
| min_matches | 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 engine is window. | |
| best_path_only | No | reduce forward segments to a non-overlapping best path (EMBOSS dotpath). Only applies when engine is word. Advanced. | |
| convert_wobbles | No | expand IUPAC ambiguity codes so a wobble matches what it stands for (FlexiDot). Only applies when engine is word. Advanced. | |
| reverse_complement | No | also plot matches against the reverse complement (k-mer engine). Only applies when engine is word. | |
| max_unknown_percent | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| plot | Yes | the full result — segments or points, plus axis lengths |
| stats | Yes | longest runs, run counts and per-sequence coverage |
| coverage | Yes | fraction of the subject covered by at least one forward match (0–1) |
| longestForward | Yes | residues on the longest uninterrupted forward run |
dot_plot_gridARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| gap | No | residues of blank space drawn between panels in the composite layout (EMBOSS default 10). Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequences | Yes | the set to compare all against all — wire several upstream outputs here, or list library document names/ids. | |
| word_size | 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. | |
| nucleotide | No | nucleotide rather than protein. Advanced. | |
| max_residues | No | refuse when the set's total residue count exceeds this. In bp. Advanced. | |
| max_sequences | No | refuse a set larger than this rather than starting N² comparisons. Advanced. | |
| best_path_only | No | reduce each panel's forward runs to a non-overlapping best path (EMBOSS dotpath). Advanced. | |
| convert_wobbles | No | expand IUPAC ambiguity codes so a wobble matches what it stands for. Advanced. | |
| include_subject | No | also include the node's subject (the open or wired record) as a member of the set. | |
| reverse_complement | No | plot each pair against the reverse complement too. Not an EMBOSS capability — ours, so an inversion between two members is visible. | |
| max_unknown_percent | No | percentage of a k-mer allowed to be N (or X for protein) before it is skipped. In %. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| grid | Yes | the full result — every panel's runs plus its offset in the composite coordinate space |
| summary | Yes | EMBOSS's per-sequence table — name, length, and the matches drawn in that sequence's whole column |
| sequences | Yes | the set as plotted, in grid order, with each member's length |
| memberCount | Yes | members in the set (the grid is this squared) |
| sharingPairs | Yes | off-diagonal panels carrying at least one shared word — how connected the set is, the leading diagonal excluded because a member always matches itself |
draw_alignmentBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | first column drawn, 1-based and inclusive. Clamped into the alignment. | |
| rows | Yes | the ALIGNED rows, each {name, aligned}; every row must already be the same length. Wire `alignedSequences` from align_sequences. | |
| ruler | No | print the column numbers over the block. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| scheme | No | 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 `scheme` then says. Values: identity (Column identity), nucleotide (Base colours). | identity |
| columns | No | how many columns to draw. Past about 200 the letters are narrower than the strokes that make them. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cell_width | No | width of one column's cell. In px. Advanced. | |
| name_chars | 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. | |
| row_height | No | height of one row. In px. Advanced. | |
| conservation | No | print the conservation line under the block. |
Output Schema
| Name | Required | Description |
|---|---|---|
| svg | Yes | the alignment block as an SVG figure |
| rows | Yes | rows drawn |
| width | Yes | figure width in px |
| height | Yes | figure height in px |
| scheme | Yes | the scheme ACTUALLY used, which is `identity` whenever `nucleotide` was asked for over protein rows |
| columns | Yes | columns in the WHOLE alignment, so the window can be read against it |
| alphabet | Yes | the alphabet the conservation line was computed for — Easel marks the strong and weak groups for protein only |
| lastColumn | Yes | last column drawn, 1-based inclusive |
| firstColumn | Yes | first column drawn, 1-based inclusive, AFTER clamping |
| meanIdentity | Yes | mean per-column identity over the window drawn, 0-1 — the window's, not the alignment's |
| conservedColumns | Yes | columns in the window every row agrees on and none gaps — the `*` marks |
draw_gelBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| lanes | Yes | the lanes, each {name, lengths: [bp, …]}. The marker lane is added for you — `ladder` chooses it. | |
| stain | 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). | etbr |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| labels | 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. | |
| ladder | 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-Lo DNA Marker (50–10,000)), generuler_1kb (GeneRuler 1 kb (250–10,000)), generuler_100bp (GeneRuler 100 bp (100–3,000)), generuler_100bp_plus (GeneRuler 100 bp Plus (100–3,000)), thermo_1kb_plus (Thermo 1 Kb Plus (100–15,000)), neb_1kb (NEB 1 kb (500–10,000)), neb_100bp (NEB 100 bp (100–1,517)), lambda_hindiii (Lambda DNA / HindIII (125–23,130)), penn_state (PennState (500–10,000)). | generuler_1kb_plus |
| caption | No | the line under the plate naming the curve that positioned the bands and what their brightness is relative to. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| dna_form | 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), supercoiled (Supercoiled), nicked (Nicked), relaxed (Relaxed). Only applies when agarose_percent is set. Advanced. | linear |
| exposure | 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 (brightness can no longer be compared between lanes). Values: plate (Whole plate), lane (Per lane). | plate |
| lane_width | No | how wide each lane is drawn. In px. Advanced. | |
| mobility_model | 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 applies when agarose_percent is set. Advanced. | helling-goodman-boyer |
| agarose_percent | 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 ladder-calibrated placement. In %. |
Output Schema
| Name | Required | Description |
|---|---|---|
| svg | Yes | the gel as an SVG figure, carrying the photographed plate and its labels |
| width | Yes | figure width in px |
| height | Yes | figure height in px |
| ladder | Yes | the marker in the reference lane |
| offScale | Yes | fragments the curve could not place, so they are NOT on the picture — check this before reading a lane as complete |
| bandCount | Yes | bands with a position on this plate — what the picture shows |
| laneCount | Yes | sample lanes drawn, the marker lane excluded |
| calibratedBy | Yes | the (bp, Rf) curve that positioned every lane |
draw_traceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | first base drawn, 1-based and inclusive. Clamped into the read. | |
| bases | 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 | No | figure width. It SETS the per-base zoom for the window asked for, never crops it. In px. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| palette | 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)), cvd (Color-blind safe), print (Print (on white)). | |
| quality | No | print the per-base Phred bars. A file with no confidence (many SCFs) draws none whatever this says. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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. | |
| bases_row | No | print the called bases between the ruler and the peaks. Advanced. | |
| trace_height | No | height of the peak band, under the ruler, quality and base rows. In px. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| svg | Yes | the trace window as an SVG figure |
| read | Yes | the read drawn |
| width | Yes | figure width in px |
| height | Yes | figure height in px |
| lastBase | Yes | last base drawn, 1-based inclusive |
| sequence | Yes | the calls in the window drawn, so the picture and the string cannot disagree |
| firstBase | Yes | first base drawn, 1-based inclusive, AFTER clamping into the read |
| hasQuality | Yes | whether this file carries per-base confidence at all |
| meanQuality | Yes | mean Phred over the window drawn, or 0 when the file carries no confidence — read `hasQuality` beside it rather than reading 0 as bad calls |
draw_treeARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| width | No | figure width. In px. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| height | No | figure height. In px. | |
| layout | 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), slanted (Slanted), circular (Circular), unrooted (Unrooted). | rectangular |
| newick | Yes | the tree to draw — wire `newick` from build_tree, or paste one. | |
| support | No | print each internal branch's support value where it carries one. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| font_size | No | tip-label size. In px. Advanced. | |
| tip_labels | No | print each tip's name, reserving the gutter they need. | |
| length_unit | 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. | substitutions/site |
| min_support | No | below this, a support value is not printed. Only applies when support is true. Advanced. | |
| branch_lengths | 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. | |
| unrooted_method | 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. | equal-angle |
Output Schema
| Name | Required | Description |
|---|---|---|
| svg | Yes | the figure as an SVG string |
| width | Yes | figure width in px |
| height | Yes | figure height in px |
| tipCount | Yes | tips drawn |
| pixelsPerUnit | Yes | px per unit of branch length in THIS drawing, or 0 when the drawing is not to scale and no bar was drawn |
ebi_alignCRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | ||
| stype | No | query alphabet, where the service takes one. Values: dna (nucleotide), protein (protein). | dna |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| service | 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 (Kalign — Wu-Manber approximate-string-matching MSA), tcoffee (T-Coffee — Consistency-based MSA), emboss_needle (EMBOSS needle — Needleman–Wunsch GLOBAL pairwise alignment: end-to-end, the whole of both sequences.), emboss_water (EMBOSS water — Smith–Waterman LOCAL pairwise alignment: the best-matching subregion, ignoring the rest.), emboss_matcher (EMBOSS matcher — Waterman–Eggert local pairwise alignment, like water, but it can report several alternative non-overlapping local alignments instead of only the single best one.), emboss_stretcher (EMBOSS stretcher — Myers–Miller GLOBAL pairwise alignment in linear space: the same answer needle gives, on sequence pairs too long for needle to hold in memory.), lalign (LALIGN — Huang & Miller), hmmer3_phmmer (HMMER phmmer — Profile HMM search of one protein against a protein database), hmmer3_hmmscan (HMMER hmmscan — Search ONE protein against a profile-HMM library), psiblast (PSI-BLAST — Position-Specific Iterated BLAST: it builds a profile from the hits of one round and searches again with it, which finds remote homologues plain blastp misses.), phobius (Phobius — Combined signal-peptide and transmembrane-topology prediction: the two are modeled together, so a signal peptide is not miscalled as a TM helix.), radar (RADAR — Rapid Automatic Detection and Alignment of Repeats: finds a protein’s INTERNAL repeats and aligns the copies against each other, without a library to match them to.), pratt (Pratt — Pattern discovery). | clustalo |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequences | 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. | |
| parameters | 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 service does not advertise is refused by name rather than dropped, and so is a value outside the list it publishes for this alphabet. | |
| include_subject | No | include the record this step is running on as the first sequence. |
Output Schema
| Name | Required | Description |
|---|---|---|
| raw | Yes | the native text the service returned, for download |
| hits | Yes | the PSI-BLAST hit table, in the same shape blast_search hands downstream |
| rows | Yes | the aligned rows as plain strings, ready to wire into build_tree or a scorer |
| jobId | Yes | the dispatcher job id: what a methods section cites and what re-fetches this exact result |
| local | Yes | LALIGN’s non-overlapping local alignments, each with its own score, E-value and spans |
| newick | Yes | the service's own guide tree, ready for the Phylogenetics tool |
| repeats | Yes | RADAR’s internal repeat families, each copy with its residue span and its two scores |
| identity | Yes | the percent-identity matrix the service computed |
| pairwise | Yes | the pairwise report (needle/water/matcher/stretcher) |
| patterns | Yes | Pratt’s discovered patterns in PROSITE notation, each with where it matched in every sequence |
| topology | Yes | the Phobius signal-peptide and transmembrane features, with their spans |
| alignment | Yes | the aligned sequences (multiple-alignment services) |
| profileHits | Yes | the HMMER hits (phmmer, hmmscan) with their domains and inclusion thresholds |
enumerate_protonation_statesBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| ph_max | No | upper end of the pH window. | |
| ph_min | No | lower end of the pH window. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| molecule | Yes | the structure: SMILES or a molfile. | |
| precision | No | how many standard deviations of each group's pKa widen its window, 0–10. | |
| max_variants | No | stop enumerating past this many states (later groups are then not visited). |
Output Schema
| Name | Required | Description |
|---|---|---|
| sites | Yes | per ionisable site: Dimorphite name, SMARTS, each pKa (mean, stdev, state) and its atoms on the input (0-based, implicit hydrogens), or null when they do not map |
| capped | Yes | true when the enumeration stopped at max_variants |
| states | Yes | every protonation state as canonical SMILES, sorted |
| summary | Yes | the enumeration in words, generated from this run, with its caveats |
enumerate_reactionARead-onlyInspect
Run a reaction SMARTS over lists of reactants, every combination, with RDKit's reaction engine: one list per reactant template, in template order.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| smarts | No | your own reaction SMARTS, reactants>>products. Only applies when template is custom. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| template | No | the library reaction to run, or custom for your own SMARTS. | 83_Schotten_Baumann_amide |
| reactants | Yes | one list of SMILES or molfiles per reactant template, in template order. | |
| max_combinations | No | stop after this many reactant combinations. |
Output Schema
| Name | Required | Description |
|---|---|---|
| capped | Yes | true when the run stopped at max_combinations |
| summary | Yes | the run in words: products, combinations, and what was dropped or capped |
| products | Yes | every product set as SMILES with the 0-based index of each reactant that made it |
enzyme_collectionARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | 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 returning an empty set. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many enzymes resolved — branch on this rather than counting the array |
| census | Yes | what this collection does to the open record, counted once: bases scanned, whether the scan wrapped the origin, names asked and resolved, total cuts, and how many enzymes cut it once, twice or more. Absent when nothing is open. This is the collection panel's own reading, so the sentence the door returns and the numbers it returns cannot disagree |
| cutting | Yes | per enzyme, how many times it cuts the OPEN record — absent when nothing is open, because a cut count with no molecule behind it is a number nobody asked for |
| enzymes | Yes | the enzyme names in the collection, ready to wire into any tool's `enzymes` parameter — the resolvable ones only, so a downstream digest never refuses on a name this step already knew was unusable |
| available | Yes | every collection you have, by name, with its size and whether it is the active one — so a run that named the wrong collection can say what the right names were |
| collection | Yes | the collection this answered for, or 'the whole catalog' when nothing is scoped |
| unresolved | Yes | names in the collection that the bundled cut catalog does not carry, usually a custom enzyme defined in the panel or a supplier spelling. Reported rather than dropped: a set that silently shrinks is the reason a digest comes back short |
| singleCutters | Yes | the enzymes cutting the open record exactly once — the ones a linearization or a directional clone can use. Empty when nothing is open |
enzyme_cut_countsCRead-onlyInspect
Per-enzyme cut counts on the open plasmid (the EcoRI² superscript-badge numbers).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | 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 collection. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| total | Yes | total cuts across every enzyme asked about |
| counts | Yes | enzyme → cut-count map; an enzyme with no sites is present with 0, never omitted |
| single | Yes | how many cut EXACTLY once: the enzymes that linearise this molecule |
| cutters | Yes | how many of the enzymes cut at least once |
| zero_cutters | Yes | how many were scanned for and have no site here |
estimate_effect_sizeARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| ci | No | the confidence level of the interval. | |
| group | No | the group compared. Left unset, the second group to appear. | |
| power | No | size the design for this power; leave empty to estimate the effect only. | |
| table | Yes | the pilot: a header row, then one row per observation. Tab- or comma-separated. | |
| value | Yes | the column holding the measurement. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| groups | No | one group label per data row, in row order, separated by commas, spaces or new lines, when the table has no group column. | |
| paired | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| subtract | No | a column subtracted from the measurement row by row before anything else: a reference gene's Ct (giving delta-Ct), a baseline. | |
| estimator | 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 treatment changes the spread. Values: hedges_g (Hedges' g), cohens_d (Cohen's d), glass_delta (Glass's Δ). | hedges_g |
| pooled_sd | 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. | |
| reference | No | the group it is compared against (the control). Left unset, the first group to appear. | |
| sig_level | No | α for the sizing. Advanced. | |
| alternative | 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. | two.sided |
| group_column | No | the column naming each row's group. Or give `groups`. |
Output Schema
| Name | Required | Description |
|---|---|---|
| design | Yes | what calculate_power takes: the t test's d (`effect`), and the raw `difference` and `sd` for t_raw |
| groups | Yes | every group in the table: n, mean and SD of the measurement |
| sizing | Yes | pwr.t.test's sample size at the estimate and at the limit nearest zero, when power was given |
| estimate | Yes | the standardized effect |
| interval | Yes | the confidence interval: level, low, high |
estimate_spillover_from_controlsARead-onlyInspect
flowStats spillover() on single-stained control tubes and an unstained tube from the project: per tube the median (or mean, or density mode) of every detector, the unstained baseline subtracted, each stained tube matched to its channel (by name distance or tube order), each row divided by its own detector.
| Name | Required | Description | Default |
|---|---|---|---|
| fsc | No | forward scatter channel, left out of the matrix. | FSC-A |
| ssc | No | side scatter channel, left out of the matrix. | SSC-A |
| tubes | Yes | the control FCS files in the project, by name or id, comma-separated, the unstained one included. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| pattern | No | regular expression the detectors must match; empty for all. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| statistic | No | the per-tube statistic. Values: median (median), mean (mean), mode (density mode). | median |
| unstained | Yes | which of the tubes is unstained, by name or id. | |
| stain_match | No | how tubes are matched to channels. Values: intensity (by name), ordered (in tube order). | intensity |
Output Schema
| Name | Required | Description |
|---|---|---|
| matrix | Yes | the spillover matrix, rows the stained channels, columns the detectors |
| matching | Yes | tube → channel |
| warnings | Yes | flowStats' warnings |
export_barcodesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| format | 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). | csv |
| prefix | No | name prefix for the rows (BC001, BC002 …). | BC |
| primer | No | the primer the tag is added to. Only applies when format is primers. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| barcodes | Yes | the index sequences to write out. | |
| adapter_3 | No | sequence 3' of the tag in the adapter — the TruSeq read-1 primer, as the panel offers. Only applies when format is adapters. | ACACTCTTTCCCTACACGACGCTCTTCCGATCT |
| adapter_5 | No | sequence 5' of the tag in the adapter — the Illumina P5, as the panel offers. Only applies when format is adapters. | AATGATACGGCGACCACCGAGATCTACAC |
| idt_scale | 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 | No | IDT purification (e.g. STD, PAGE, HPLC). Check what your scale allows before ordering. Only applies when format is idt. |
Output Schema
| Name | Required | Description |
|---|---|---|
| text | Yes | the written file, for the text formats |
| count | Yes | how many barcodes were written |
| oligos | Yes | the emitted oligos, for the adapter and primer formats — empty for the text formats |
| warnings | Yes | junction warnings the emission found — a tag that creates a homopolymer or a restriction site at its junction. Empty for the text formats, which build no junction |
export_construction_recordARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| format | 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 source cannot carry is refused by name rather than answered with an empty file. Values: methods (Methods (Markdown)), steps_csv (Steps (CSV)), record_json (Full record (JSON)), genbank (GenBank with construction history), opencloning (OpenCloning document (JSON)), queen_script (Reconstruction script (Python)), sbol (SBOL 2 construction record). | methods |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | No | File id or name. The focused document when omitted, exactly as the panel. | |
| sbol_syntax | 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 default because it is what the writer composes and what libSBOLj validates; the rest are re-serialised from that exact document. Ignored unless `format` is `sbol`, and saying so is refused rather than silently dropped. Values: rdfxml (RDF/XML), turtle (Turtle), ntriples (N-Triples), nquads (N-Quads), trig (TriG), jsonld (JSON-LD). Only applies when format is sbol. | rdfxml |
Output Schema
| Name | Required | Description |
|---|---|---|
| text | Yes | the document itself, byte for byte what the panel’s download writes |
| format | Yes | the format actually written: echoed because it is defaulted, not required |
| source | Yes | which of the 5 records this was written from: the workbench log, a SnapGene .dna reaction graph, a QUEEN build script, an OpenCloning strategy, or an SBOL 2/3 construction record |
| syntax | Yes | the RDF syntax the SBOL record was written in, echoed because it is defaulted. Empty for every other format, which do not have one |
| caution | Yes | what the panel warns about after this write, when it warns. Empty is the healthy case: a GenBank whose construct carries no other annotation will not read its own history back, and the file looks perfect either way |
| filename | Yes | the name the panel saves it under, so a pipeline writing several agrees with it |
| available | Yes | the formats THIS record can produce, and for each one it cannot, why: the panel’s own enabled/disabled derivation, so a pipeline can branch on it instead of failing |
export_map_svgBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| end | 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. | |
| font | No | figure font — one of the three stacks that survive an SVG-to-PDF conversion without substitution. | sans |
| size | No | square canvas edge, before a legend strip is added below it. In px. | |
| start | 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. | |
| title | No | figure title; left empty, the record's own name is used. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| layout | No | circular: the ring; linear: the record unrolled into rows, features in lanes under a ruler and sites above it. | circular |
| legend | No | add a colour key on its own strip below the map. | |
| enzymes | 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 collection; with none active the ring is drawn empty rather than silently filled. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| show_bases | No | linear only: draw both strands' bases over the ruler; rows wrap to keep each base readable. Only applies when layout is linear. | |
| show_sites | No | draw the outer restriction-site ring. | |
| show_labels | No | draw each feature's name beside its arc. | |
| transparent | No | omit the backing rect, so the figure drops onto any ground. | |
| collapse_duplicate_labels | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| svg | Yes | publication SVG string |
| rows | Yes | rows a linear map wrapped into; 0 for the circular layout |
| sites | Yes | cut sites drawn (the outer ring, or the ticks above a linear map's ruler) |
| width | Yes | rendered width in px |
| height | Yes | rendered height in px — taller than the width when a legend strip was added |
export_traceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | 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 it does not; `mott` is the instrument's record, which SCF and ZTR never carry; `window` always computes it here. | none |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| format | 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. | fasta |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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. | |
| use_internal_name | 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 file with no internal record uses its filename either way, and says so. |
Output Schema
| Name | Required | Description |
|---|---|---|
| text | Yes | the file, as text. A VALUE and not a download, deliberately: a graph step that wrote to disk could not be composed with the step after it |
| bases | Yes | how many bases the file carries |
| reading | Yes | the same sentence the editor shows for this export, generated from it |
| filename | Yes | the name this would be saved as, with the user's own extension for this format applied |
| sequence | Yes | just the bases that were written, so a downstream step does not have to parse the record back apart |
| trimUsed | Yes | which trim actually ran. `auto` answers `window` on a file with no Mott record, so a pipeline that assumed otherwise trimmed on a threshold nobody chose — the same trap `trim_trace`'s `methodUsed` exists for |
| fileBases | Yes | how many calls the trace file holds. Read it against `bases`: the difference is what the bounds cut |
| lastBaseKept | Yes | 1-based inclusive |
| firstBaseKept | Yes | 1-based inclusive, the same convention `trim_trace` reports in and every trim readout in the editor uses |
| carriedQuality | Yes | whether the per-base Phred reached the file. False on every target but FASTQ, and on a read that never had one |
export_treeARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | the tree's name inside the written file (NEXUS and NeXML carry one). Advanced. | tree1 |
| tree | Yes | the tree, in any of the four formats. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| format | No | the format to write. Values: newick (Newick), nexus (NEXUS), phyloxml (PhyloXML), nexml (NeXML). | newick |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| text | Yes | the tree written in the requested format |
| sourceFormat | Yes | the format the input was sniffed as — check this when a conversion surprises you |
fastq_qcBRead-onlyInspect
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 with FastQC's own pass/warn/fail grade and the limit it was graded on.
| Name | Required | Description | Default |
|---|---|---|---|
| reads | Yes | the reads, as FASTQ: four lines per record, quality line required. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| adapters | 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. | |
| grouping | 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). | linear |
| contaminants | 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. | |
| phred_offset | No | quality encoding: 33 for every modern FASTQ, 64 only for pre-1.8 Illumina (FastQC's --phred64). Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| failed | Yes | how many modules FastQC would fail |
| grades | Yes | module name to pass, warn or fail |
| report | Yes | every module's table and grade: perBaseQuality (boxes), perTileQuality (null without tiles), perSequenceQuality, perBaseContent, perSequenceGc (counts, theoretical, mode, stdev, deviationPercent), nContent, lengthDistribution, duplication (percentOfTotal, percentRemaining), overrepresented (sequences with count, percentage, possibleSource), adapterContent |
| gcDeviationPercent | Yes | how far the per-read GC distribution sits from FastQC's normal, as a percent of reads |
fetch_articleARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | the PMCID (PMC13627669) or PMID (39012345) of the paper. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| pmcid | Yes | the PMCID Europe PMC served it under |
| title | Yes | the article's title |
| license | Yes | the article's own license statement, as the publisher wrote it |
| markdown | Yes | the whole article as Markdown, figure references linked to their captions |
| endpoints | Yes | the URLs actually called |
| retrievedAt | Yes | when it was fetched |
fetch_clinvar_vcfARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| end | Yes | last base of the region (1-based, inclusive). | |
| chrom | Yes | the chromosome, with or without its chr prefix. | |
| start | Yes | first base of the region (1-based). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| assembly | No | which release VCF to read. | GRCh38 |
| max_records | No | cap on records returned; the result says when the region held more. |
Output Schema
| Name | Required | Description |
|---|---|---|
| vcf | Yes | ClinVar's header and the region's records, as the file holds them |
| records | Yes | how many records the region returned |
| summary | Yes | which release was read, and how many records the region held |
| fileDate | Yes | the release's own ##fileDate, which names the release read |
| endpoints | Yes | the VCF and index URLs actually read |
| truncated | Yes | whether the region held more records than max_records |
fetch_recordARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| db | No | Dbfetch only: which of its databases. Only applies when source is dbfetch. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| format | No | Dbfetch only: which of that database's formats. Only applies when source is dbfetch. | |
| source | 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). | ncbi |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| accession | 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`. | |
| record_index | No | which record to emit when the fetched file holds several (0-based). |
Output Schema
| Name | Required | Description |
|---|---|---|
| name | Yes | the record name the archive gave it |
| length | Yes | its length in bases (or residues, for a protein) |
| record | Yes | the fetched sequence, ready for a downstream node's $subject |
| circular | Yes | whether the archive says it is circular |
| provenance | Yes | the archive, the accession, the URL and when it was fetched — what makes the result re-fetchable |
| featureCount | Yes | how many annotations came with it |
filter_itemsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| max | No | upper bound, inclusive. Only applies when operator is between. | |
| min | No | lower bound, inclusive. Only applies when operator is between. | |
| set | No | the values the field must be one of (or none of). Only applies when operator is in or not_in. | |
| text | No | the text a field must contain. Only applies when operator is contains. | |
| field | 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. | |
| items | Yes | the rows to filter — wire a json/list output (bands, guides, assays, amplicons). | |
| value | No | the value to compare against. Only applies when operator is == or != or > or >= or < or <=. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| operator | 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 (contains text), is_true (is true), not_empty (is not empty). | >= |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many rows were kept — wire this into check_value to gate on it |
| items | Yes | the rows that met the condition |
| dropped | Yes | how many rows were removed |
find_accessionsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | the text to scan, e.g. the markdown fetch_article returns. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| found | Yes | each resolved accession with the record it names (archive, title, organism, length) and how often the text mentions it |
| summary | Yes | how many accessions resolved, at which archives, and how many spans did not |
| accessions | Yes | every resolved accession as the text writes it, in text order |
| namespaces | Yes | the identifiers.org namespaces read, by prefix and registry name |
| unresolved | Yes | spans a pattern admitted that no archive holds |
find_assembliesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| assembly | 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. | |
| organism | Yes | a scientific name, a common name, or a taxonomy id (NCBI Datasets accepts all three). "Escherichia coli", "human", "559292" are all valid. | |
| replicons | 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'. |
Output Schema
| Name | Required | Description |
|---|---|---|
| length | Yes | that replicon’s length in bases, so a region can be chosen against a real span |
| assembly | Yes | the chosen assembly accession: the one asked for, else this organism’s reference-first top hit |
| organism | Yes | the assembly record's own organism name, canonical rather than the words that were typed |
| accession | Yes | the largest replicon's nucleotide accession: for most genomes the main chromosome, and what a fetch_record node's $accession wants |
| replicons | Yes | the chosen assembly's assembled molecules (accession, name, length and molecule type), or empty when replicons were not asked for |
| assemblies | Yes | every current assembly NCBI publishes for the organism: accession, RefSeq or GenBank, assembly level, organism, tax id, release date and total length |
find_linear_motifsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| domains | 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. `20-153@G3DSA:3.90.180.10, 296-341@G3DSA:3.90.180.10`. Pass the FRAGMENTS of an InterProScan domain match, not its outer span. Empty falls back to the scan the Protein domains panel holds, which is the only source the in-browser doors need. Only applies when filterInDomains is true. | |
| protein | Yes | the protein sequence, one-letter codes; wire it from translate_sequence or read it off a CDS. | |
| species | 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 that species' lineage is dropped, with its range. Empty runs no taxon filter, which is ELM's own default. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| families | 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, which is what the panel does when every family is unticked. | |
| compartments | 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. | |
| expectCutoff | 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)” listing. | |
| filterInDomains | 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 holds; with neither, the call refuses rather than silently not filtering. | |
| structuralContext | 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-character PDB id (e.g. `1crn`) uses that experimental entry and yields Q_acc, Q_sse and ELM's three-way verdict, because only a real entry has a DSSP file. Either way the protein is resolved to its UniProt entry by sequence checksum first, and the call refuses if it is not an exact match. |
Output Schema
| Name | Required | Description |
|---|---|---|
| hits | Yes | each surviving motif, in the engine’s own field names: identifier, accession, functionalSiteName, description, 1-based start/end, the residues that matched, the class chance probability, and how many experimentally annotated instances ELM holds |
| count | Yes | surviving motifs, after every filter that ran |
| accounting | Yes | what the scan was actually run against — classes scanned, classes skipped by the cutoff, classes skipped by the family selection — so a hit count can be read against its denominator rather than on its own |
| provenance | Yes | the ELM release and date the scan ran against, and the filters that ran |
find_orfsBRead-onlyInspect
Find open reading frames on BOTH strands of the subject (origin-spanning when circular).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| min_size | No | minimum ORF size. In bp. | |
| alternative_starts | No | also accept GTG/CTG as start codons (not just ATG). |
Output Schema
| Name | Required | Description |
|---|---|---|
| orfs | Yes | the ORFs (start, end, frame, strand) |
| count | Yes | number of ORFs found |
| longest | Yes | length of the longest ORF in bp |
find_primer_snpsBRead-onlyInspect
Find known SNPs under primers, the check NCBI Primer-BLAST makes with "Primer binding site may not contain known SNP".
| Name | Required | Description | Default |
|---|---|---|---|
| pairs | No | the pairs to check, as design_primer_pairs' `pairs` output (each with forward and reverse start/end on the template). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| forward | No | a forward primer to locate on the template by exact match, when no `pairs` are given. | |
| reverse | No | a reverse primer to locate by exact match of its reverse complement. | |
| snp_set | 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 primers avoid them all. `dbSnp155ClinVar`: About 820,000 variants ClinVar mentions, benign and pathogenic alike. | dbSnp155Common |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| assembly | Yes | the UCSC assembly id the template was cut from (hg38, mm39, danRer11…). | |
| position | 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. | |
| template | No | the sequence the primers sit on. Left empty, the open record is used. | |
| window_end | No | 1-based last base of the span to check. Advanced. | |
| window_start | No | 1-based first base of the template span to check. Unset = the whole template. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| snps | Yes | every SNP in the span, placed on the template (0-based, end-exclusive), with alleles as they read on the template's strand and whether the template spells dbSNP's reference allele there |
| flagged | Yes | how many primers sit on at least one known SNP |
| primers | Yes | every primer checked: its name, span on the template, strand, and the SNPs under it with rsID, alleles, minor allele frequency and distance from the 3′ end (1 = the 3′ base) |
| excluded | Yes | the SNP spans, for design_primer_pairs' `excluded` |
find_restriction_sitesBRead-onlyInspect
Cut positions of the given enzymes on the open plasmid (top/bottom cut, overhang, kind).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | 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 collection. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| sites | Yes | cut sites on the subject |
find_star_sitesBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | 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 | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| sites | Yes | total possible star sites across the enzymes REBASE has examined |
| enzymes | Yes | per enzyme: whether REBASE examined it, and its possible star sites here |
| unexamined | Yes | how many of the enzymes REBASE has NOT tested for star activity |
flow_cytometry_kineticsBRead-onlyInspect
A statistic of one channel of an FCS file over acquisition time (FlowJo's Kinetics): the median, mean, geometric mean, a percentile or the % of events above a threshold, in equal time bins, optionally only of events above the threshold and smoothed; per time range the peak and its time, mean Y, least-squares slope, area under the curve and dt.
| Name | Required | Description | Default |
|---|---|---|---|
| A | No | additional negative decades. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| M | No | decades of the full scale. Only applies when scale is logicle or hyperlog or flowcore-logicle or fasinh. | |
| T | No | top of scale; empty means the file's largest fluorescence $PnR. | |
| W | No | linear width in decades. Only applies when scale is logicle or hyperlog or flowcore-logicle. | |
| scale | No | the display scale of the fluorescence channels (scatter and time stay linear): used for the plot, the threshold and, with `stats_on: scaled`, the statistics. Values: logicle (Logicle (Gating-ML 2.0, Moore & Parks)), fasinh (ArcSinh (Gating-ML 2.0 fasinh)), arcsinh (ArcSinh with a cofactor (asinh(x / c), Cytobank and CyTOF)), hyperlog (Hyperlog (Gating-ML 2.0, Bagwell)), flowcore-logicle (Logicle on a 0–M axis (flowCore)), wsp-biex (Biex (FlowJo 10, channels 0–4096)), flin (Linear (Gating-ML flin)). | logicle |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| gating | No | a Gating-ML 2.0 document in the project, by name or id; empty for no gating (every statistic is then of all events). | |
| plot_x | No | channel (PnN or PnS) on the density plot's x axis; empty for no plot. | |
| plot_y | No | channel on the plot's y axis. | |
| ranges | No | time ranges `start-end` separated by `;`, in the time unit (seconds). | |
| channel | No | the channel followed (PnN, PnS or a derived name); empty for the first fluorescence channel. | |
| derived | No | derived parameters, `name = expression` separated by `;` (FlowJo's vocabulary: channels by name or [name], + − * / % ^, abs ceil floor neg round max min pow exp ln log sqrt and the trig functions); each becomes a channel of the run. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cofactor | No | the c in asinh(x / c): 5 is the CyTOF convention, 150 a common one for fluorescence. Only applies when scale is arcsinh. | |
| document | No | the FCS file, by name or id; may be left empty when the project holds exactly one. | |
| smoothing | No | curve smoothing. Values: none (none), movingAverage (moving average), gaussian (Gaussian). | none |
| statistic | No | the statistic per time bin. Values: median (median), mean (mean), geomean (geometric mean), percentile (percentile), percentAbove (% above T). | median |
| threshold | No | the threshold T. Values: none (none), absolute (a value), percentileOfRange (a percentile of a time range). | none |
| biex_width | No | FlowJo biex width basis (negative; FlowJo's default -10). Only applies when scale is wsp-biex. | |
| half_width | No | smoothing window, ± bins (Gaussian σ = half of it). | |
| percentile | No | for statistic = percentile. Only applies when statistic is percentile. | |
| population | No | the population; empty for all events. | |
| compensation | No | `auto`: the file's own $SPILLOVER/$SPILL when it has one, else none; `file`: that, refusing a file without one; `none`: leave the values as acquired. Values: auto (automatic), file (file's own matrix), none (none). | auto |
| kinetic_bins | No | equal time bins over the population’s time span. | |
| biex_negative | No | FlowJo biex extra negative decades. Only applies when scale is wsp-biex. | |
| plot_population | No | the population plotted; empty for all events. | |
| threshold_range | No | which range (1-based) the percentile is taken from. Only applies when threshold is percentileOfRange. | |
| threshold_value | No | T as a channel scale value. Only applies when threshold is absolute. | |
| compensation_method | No | which published algorithm: FlowKit's solve(Sᵀ, Xᵀ) or flowCore's X · S⁻¹. They agree to ~1e-15 of full scale. Values: flowkit (solve(Sᵀ, Xᵀ) (FlowKit)), flowcore (X · S⁻¹ (flowCore)). Only applies when compensation is auto or file. | flowkit |
| above_threshold_only | No | the statistic of events above T only. | |
| threshold_percentile | No | the percentile of the range that sets T. Only applies when threshold is percentileOfRange. |
Output Schema
| Name | Required | Description |
|---|---|---|
| bins | Yes | per time bin: start, end, centre, events, events used, value |
| curve | Yes | the displayed (smoothed) value per bin |
| ranges | Yes | per range: start, end, dt, peak, peak t, mean Y, slope, AUC |
| threshold | Yes | the threshold T used (0 when none) |
fold_guideARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| sg_rna | No | also fold the full spacer+scaffold sgRNA, not just the spacer. | |
| spacer | Yes | the protospacer to fold. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| nuclease | 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: NNGRRT (3')), SaCas9-KKH (SaCas9-KKH: NNNRRT (3')), AsCas12a (AsCas12a: TTTV (5')), LbCas12a (LbCas12a: TTTV (5')), enAsCas12a (enAsCas12a: TTTV (5')). | SpCas9 |
Output Schema
| Name | Required | Description |
|---|---|---|
| sgRna | Yes | the full sgRNA fold, when a scaffold is published for this nuclease |
| spacer | Yes | the spacer's own fold: sequence, dot-bracket structure and free energy |
| unavailable | Yes | why nothing was folded, when no scaffold is published for this nuclease; null when the fold ran |
| scaffoldName | Yes | which published scaffold was used. Null when no scaffold is published for this nuclease |
| scaffoldIntact | Yes | whether the scaffold still folds as published once the spacer is attached. Null when no scaffold is published for this nuclease: false would read as a disrupted scaffold |
| spacerScaffoldPairs | Yes | how many spacer bases pair INTO the scaffold — every one of them disrupts the structure Cas9 binds. Null when no scaffold is published for this nuclease |
fold_rnaARead-onlyInspect
Minimum-free-energy secondary structure (dot-bracket + ΔG) of an RNA/DNA sequence (Turner-2004).
| Name | Required | Description | Default |
|---|---|---|---|
| seq | Yes | the RNA/DNA sequence (T read as U). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| dg | Yes | ΔG [kcal/mol] |
| dotBracket | Yes | MFE structure (dot-bracket) |
fragment_ionsARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| ionTypes | No | ion series to generate. | |
| sequence | Yes | peptide: one-letter residues, optionally ProForma tags, e.g. [TMT6plex]-PEPTM[Oxidation]IDE or [+229.162932]-PEPTM[+15.994915]IDE. | |
| maxCharge | No | highest fragment charge (every charge from 1 up to it). |
Output Schema
| Name | Required | Description |
|---|---|---|
| ions | Yes | one row per fragment: ionType, index (residues), charge, name, m/z |
| count | Yes | fragments generated |
fusion_pcrAInspect
Overlap-extension (fusion) PCR — join fragments that share terminal homology into one product, carrying their features across (pydna).
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | minimum shared terminal homology two fragments must have to fuse (pydna's own default is 15). In bp. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| fragments | No | the fragments to fuse, in order — wire upstream `record` outputs here, or name library documents. | |
| include_subject | No | also include the node's subject as the first fragment. |
Output Schema
| Name | Required | Description |
|---|---|---|
| record | Yes | the fused product, as a record |
| report | Yes | the engine's own summary (count + sizes) |
| products | Yes | every fused product |
| junctions | Yes | the first product's joins: each overlap's product coordinates (0-based inclusive), bases, length and Tm |
| productTm | Yes | product melting temperature of the first product |
| productCount | Yes | number of products (>1 = ambiguous fusion) |
gate_dropletsARead-onlyInspect
Two-channel ddPCR droplet-amplitude exports to a template concentration, by CLASSIFYING the raw droplets rather than trusting a count the instrument already made.
| Name | Required | Description | Default |
|---|---|---|---|
| files | 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 the FILE NAME because the body does not carry it. Separate files with a line containing only `---`, and start each with `# <filename>`. | |
| x_var | No | name for the X channel, which is the file's SECOND amplitude column. Bio-Rad's Ch2 is usually HEX or VIC. | HEX |
| y_var | No | name for the Y channel, which is the file's FIRST amplitude column. Bio-Rad's Ch1 is usually FAM. | FAM |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cutoff_sd | 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. | |
| cutoff_iqr | No | how many interquartile ranges above the third quartile of that slice a droplet must sit to be an outlier. | |
| random_seed | 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 optimum and moves the empty cutoff. Upstream's default is 8. | |
| top_percent | 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. | |
| total_drops_t | No | fewer accepted droplets than this and the well is rejected before it is clustered at all. | |
| empty_lambda_low | 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. | |
| droplet_volume_ul | 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. | |
| empty_lambda_high | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many wells were read |
| wells | Yes | one row per well: droplet counts by cluster, the empty fraction, the per-well cutoffs, and the concentration in copies/uL — null for a rejected well, never a number |
| params | Yes | every parameter the run used, including the ones left at their defaults: the seed and the two cutoff multipliers change the concentration, so a reading without them is not comparable |
| rejected | Yes | how many wells were rejected by the quality check and so carry no concentration |
| verdicts | Yes | why each well passed or was rejected, with the k-means the verdict was taken from: both cluster centres, their sizes, their distances to the origin and the gap between them |
| outlierCutoff | Yes | the two plate-wide outlier cutoffs, echoed because they were computed from the successful wells only and so depend on which wells passed |
| totalDroplets | Yes | every droplet read, across every well — the denominator the cluster counts account for |
gc_contentARead-onlyInspect
GC fraction of the subject — whole-sequence, or a sliding window profile (DnaChisel).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| window | No | sliding-window size; unset = one value for the whole sequence. In bp. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| gc | Yes | GC fraction over the whole sequence (0–1) |
| plot | Yes | the windowed GC profile as a plot, by window centre (only when `window` is set) |
| profile | Yes | per-window GC fractions (only when `window` is set) |
generate_conformersARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | random seed. | |
| count | No | at most this many conformers. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| minimise | No | minimize each conformer. | |
| molecule | Yes | the structure: SMILES or a molfile. | |
| strategy | No | how torsion sets are chosen. | likelyRandom |
| force_field | No | the MMFF94 variant. | MMFF94 |
| max_iterations | No | minimiser iterations, at most. | |
| energy_tolerance | No | minimiser energy tolerance. | |
| max_torsion_sets | No | distinct torsion sets to try before stopping. | |
| gradient_tolerance | No | minimiser gradient tolerance. | |
| sixty_degree_steps | No | every rotatable bond in 60° steps instead of the torsion library's angles. |
Output Schema
| Name | Required | Description |
|---|---|---|
| summary | Yes | the ensemble in words, generated from this run |
| conformers | Yes | each conformer: molfile, energy as generated and minimized (kcal/mol) |
| file_energy | Yes | a 3D molfile's own MMFF94 energy, or why it could not be computed |
gene_set_cameraBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | the tested coefficient by name; empty is the design's last. Only applies when statistic is voom. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| counts | 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. | |
| design | No | with `counts`: the design formula, the variable of interest last. Only applies when statistic is voom. | ~ condition |
| ranked | 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. | |
| samples | No | with `counts`: one row per sample, its name first, then the design's variables. Only applies when statistic is voom. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| contrast | No | 'factor, numerator, denominator', the denominator being the factor's reference level. Only applies when statistic is voom. | |
| geneSets | 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'. | |
| minCount | No | filterByExpr: minimum count in the smallest group's worth of samples. Only applies when statistic is voom. | |
| useRanks | No | a correlation-adjusted Wilcoxon rank-sum test instead of the parametric t on z-scores; robust to a few extreme genes. | |
| fdrCutoff | No | a set is called when its BH FDR (its p-value when one set is tested) is at most this. | |
| reference | 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. | |
| statistic | 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 |
| allowNegCor | No | with an estimated correlation: let a negative estimate deflate the variance (limma floors it at 0). Only applies when statistic is voom. | |
| directional | 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|). | |
| filterByExpr | No | drop genes too lowly expressed to test (edgeR's filterByExpr) before voom. Only applies when statistic is voom. | |
| interGeneCor | No | the fixed inter-gene correlation, limma's default 0.01 (a value most real sets exceed slightly). | |
| minTotalCount | No | filterByExpr: minimum total count. Only applies when statistic is voom. | |
| estimateCorrelation | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| terms | Yes | every set with a member among the tested genes, by p: genes in the set, correlation, direction, p and BH FDR |
| summary | Yes | the mode (voom camera or cameraPR), genes tested, sets supplied and tested, the degrees of freedom, the prior df of the variance squeeze, the settings limma changed |
| enriched | Yes | the sets at or under the FDR cutoff |
gene_set_enrichmentARead-onlyInspect
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 ES against size-matched permutations, multilevel Monte Carlo p-values down to eps, adjusted p, log2err, rank at maximum, leading-edge genes.
| Name | Required | Description | Default |
|---|---|---|---|
| eps | No | floor for multilevel p-values; 0 estimates them however small. Only applies when method is multilevel. | |
| seed | 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). | |
| nperm | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| engine | 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-values; BH only, no q-value. | clusterProfiler |
| method | 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 list (slower: every set is re-scored along every permuted list). The permutation methods score both tails whatever the score type. Only applies when engine is clusterProfiler. | multilevel |
| ranked | 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. | |
| maxPerm | No | adaptive: the most draws any set gets. Only applies when adaptive is true. | |
| minPerm | No | adaptive: the first batch for every set. Only applies when adaptive is true. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| adaptive | 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. | |
| exponent | No | weight of each gene's statistic in the running sum: 0 is the unweighted Kolmogorov-Smirnov form, 1 classic GSEA. | |
| geneSets | 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'. | |
| maxGSSize | No | largest set tested, counted among the ranked genes. | |
| minGSSize | No | smallest set tested, counted among the ranked genes. | |
| scoreType | 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. | std |
| sampleSize | No | multilevel samples per level (made odd). Only applies when method is multilevel. | |
| nPermSimple | No | multilevel: permutations for the first, simple p-value estimate and the NES. Only applies when method is multilevel. | |
| permutations | 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. | |
| pvalueCutoff | No | a set is significant when p and adjusted p are at most this. | |
| pAdjustMethod | No | multiple-testing adjustment across the tested sets (R `p.adjust`). | BH |
| pvalThreshold | No | adaptive: a set whose p-value rises above this stops drawing. Only applies when adaptive is true. |
Output Schema
| Name | Required | Description |
|---|---|---|
| terms | Yes | every set in the size range, by |NES|: ES, NES, p, adjusted p, q-value, log2err, rank at maximum, leading-edge statistics and genes, and the ranks of the set's members |
| summary | Yes | ranked genes, ties, whether the list was re-sorted, sets supplied and in range, significant sets, q-value route |
| enriched | Yes | the sets passing the p and adjusted-p cutoff |
| runningScore | Yes | the running enrichment score along the ranked list for the top set, with its hits |
gene_set_overrepresentationARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| genes | Yes | the gene list (e.g. the significant genes of a DE run), one ID per line or separated by commas or spaces. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| weights | 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 (BiasedUrn), each set's odds being its members' mean weight over the rest of the background's, so a set of well-counted or long genes is not called for being easy to detect. Background genes without a weight take the median; weights at or below 0 are lifted to the smallest positive one. Empty is the unweighted test. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| geneSets | 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 | 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. | |
| maxGSSize | No | largest set tested, counted within the background. | |
| minGSSize | No | smallest set tested, counted within the background. | |
| pvalueCutoff | No | a set is enriched when p and adjusted p are at most this. | |
| qvalueCutoff | No | and its q-value at most this. | |
| forceUniverse | No | use `universe` as given instead of intersecting it with the annotated genes. | |
| pAdjustMethod | No | multiple-testing adjustment across the tested sets (R `p.adjust`). | BH |
Output Schema
| Name | Required | Description |
|---|---|---|
| terms | Yes | every tested set, by p: count, set size, gene and background ratios, fold enrichment, odds ratio, z-score, p, adjusted p, q-value, the hit genes |
| summary | Yes | input genes, how many are in the background, the background size, sets supplied, in the size range and tested, and the q-value route |
| enriched | Yes | the sets passing the p, adjusted-p and q cutoffs |
genotype_pcaARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| vcf | Yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. | |
| prune | No | drop sites in LD before the decomposition (locate_unlinked), as scikit-allel's PCA assumes. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| minMac | No | keep biallelic sites whose REF and first ALT are each seen at least this many times. | |
| scaler | 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)))), standard (Standard deviation), center (Centre only). | patterson |
| groupBy | No | which column of the sample table groups the samples; empty is its first grouping column. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| precision | 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-allel on integer genotypes)). | float64 |
| pruneSize | No | pruning window, in sites. Only applies when prune is true. | |
| pruneStep | No | sites the pruning window advances. Only applies when prune is true. | |
| nComponents | No | components to report. | |
| populations | 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. | |
| pruneThreshold | No | prune the later site of a pair whose Rogers–Huff r² exceeds this. Only applies when prune is true. |
Output Schema
| Name | Required | Description |
|---|---|---|
| sites | Yes | how many sites qualified, how many pruning kept, and their positions |
| coords | Yes | one row per sample: sample, its group, and its coordinate on each component |
| explainedVariance | Yes | the variance each reported component explains, in the data's own units (the eigenvalues) |
| explainedVarianceRatio | Yes | the share of variance each reported component explains |
get_construction_historyBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many steps to return, oldest first. All of them when omitted. | |
| query | 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 it. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | No | File id or name. The focused document when omitted, exactly as the panel. | |
| molecule | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| depth | Yes | longest chain of operations from a starting material to the construct — 1 is a single round, and more means it was built on builds |
| graph | Yes | the lineage itself: `levels`, the molecule names by round with the starting materials at 0, and `edges`, every parent → product pair. This is the Graph and Lineage tabs’ own derivation, and without it a caller holding `steps` would have to rebuild it from the recorded commands |
| steps | Yes | the recorded operations, oldest first, with their inputs, products and enzymes. A step that records a coordinate also carries `window`: the bounds as the file writes them, the molecule they are an index INTO (never this one), and the intervals of this record they project onto through the map QUEEN writes into it — empty, with a stated reason, when those bases are not in the finished molecule |
| total | Yes | recorded operations in the whole build, before any filter |
| inputs | Yes | molecules the history starts from: nothing recorded produced them |
| origin | Yes | the record this was decoded out of — NOT always the document asked for: a file with no history falls back to the project, and this names what actually answered |
| source | Yes | which of the 5 records this came from: the workbench log, a SnapGene .dna reaction graph, a QUEEN build script, an OpenCloning strategy, or an SBOL 2/3 construction record |
| enzymes | Yes | the enzymes this build cut with, as the history records them |
| matched | Yes | how many steps the `molecule`/`query` filters kept — the panel prints `matched/total`, and collapsing the two would make "12 of 12" and "12 of 76" the same answer |
| cautions | Yes | only what THIS history earned — a step the decoder could not follow, products a reaction could not have made, or a limitation of the source format. Empty is the healthy case |
| protocol | Yes | the same numbered bench-recipe protocol the panel renders and exports |
| conclusion | Yes | one generated sentence: how much was recorded, over how many rounds, from how many starting materials, and on whose authority. The same `conclusionOf` the panel headlines |
| derivation | Yes | the chain behind the answer: this history ← decoder ← read from ← graded against. The last link is absent for a build recorded here, which has no oracle behind it |
| process_flow | Yes | the build as named processes: `groups` (the author’s process names, each with its operations in execution order), `operations` (the quinable call, its depth, what it consumed and produced, and its recorded arguments), and `depth`. Absent for a record that carries no re-executable command list — only a QUEEN history does — and `unavailable` with the upstream reason for the one build shape QUEEN cannot draw itself |
get_open_recordARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| name | Yes | record name |
| length | Yes | length in bp |
| record | Yes | the open sequence record (subject for downstream nodes) |
| circular | Yes | topology (true = circular) |
| sequence | Yes | the sequence 5'→3' |
get_selectionARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| pad | No | extend the selection by this many bases on each side, clamped to the molecule (or wrapped, on a circular one). In bp. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| reverse_complement | No | emit the bottom strand of the selection (what a feature on the minus strand actually reads). |
Output Schema
| Name | Required | Description |
|---|---|---|
| end | Yes | end on the parent, exclusive |
| start | Yes | 0-based start on the parent molecule |
| length | Yes | length in bp |
| record | Yes | the selected region as a linear record (subject for downstream nodes) |
| sequence | Yes | the selected bases 5'→3' |
gibson_assembleBInspect
Assemble fragments by terminal homology (Gibson / NEBuilder / In-Fusion, DnaCauldron).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| max_tm | No | optional ceiling on the same gate scale. 0 = no constraint. In °C. Advanced. | |
| min_tm | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| topology | No | product topology to enumerate. Values: circular (Circular), linear (Linear), both (Both). | circular |
| fragments | No | the fragments to assemble — wire upstream `record` outputs here, or list library document names/ids. | |
| max_constructs | No | cap on how many distinct constructs are enumerated, so an ambiguous fragment set cannot run away. Advanced. | |
| include_subject | No | also include the node's subject as a fragment. | |
| max_homology_bp | 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_homology_bp | No | minimum terminal homology for two ends to join. In bp. | |
| expect_no_unused_parts | No | treat a fragment left out of every construct as an error rather than a warning (upstream's own default). | |
| preserve_backbone_origin | No | for circular products, rotate the origin to the start of the backbone fragment and name the product after it. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| errors | Yes | assembly errors — the structured flaws DnaCauldron's errors spreadsheet is built from |
| record | Yes | the first assembled product, as a record |
| products | Yes | every enumerated product |
| warnings | Yes | assembly warnings |
| productCount | Yes | number of products (>1 = ambiguous assembly) |
golden_gate_assembleAInspect
Assemble parts with a Type-IIS enzyme (Golden Gate / MoClo, DnaCauldron). Emits the first construct as a NEW record for downstream nodes.
| Name | Required | Description | Default |
|---|---|---|---|
| parts | No | the parts to assemble — wire upstream `record` outputs here, or list library document names/ids. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzyme | No | Type-IIS enzyme, or leave unset to let DnaCauldron pick one. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| connectors | 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 candidate it does not need is silently unused. | |
| max_constructs | No | cap on enumerated constructs. Advanced. | |
| include_subject | No | also include the node's subject as a part. | |
| expected_constructs | No | expect exactly this many constructs and fail when the count differs. Leave unset to enumerate every valid one. | |
| expect_no_unused_parts | No | treat a part the assembly did not consume as an error, which is DnaCauldron's own default. |
Output Schema
| Name | Required | Description |
|---|---|---|
| enzyme | Yes | the Type-IIS enzyme actually used |
| errors | Yes | assembly errors — the structured flaws DnaCauldron's errors spreadsheet is built from |
| record | Yes | the first assembled construct, as a record |
| products | Yes | every enumerated construct |
| warnings | Yes | assembly warnings |
| overhangs | Yes | the first construct’s junction overhangs, in assembly order: wire this into score_overhang_fidelity |
| productCount | Yes | number of constructs |
graft_antibody_cdrsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | graft onto the n-th closest germline instead of the closest (0-based). | |
| jGene | No | use this human J germline instead of the closest one. | |
| vGene | No | use this human V germline instead of the closest one (a family, gene or allele: IGHV1, IGHV1-18, IGHV1-18*01). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| domain | No | which variable domain to graft when the sequence holds several (0-based, in sequence order). | |
| protein | Yes | the protein sequence (one-letter amino acids); the variable domains in it are found and numbered first. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cdrDefinition | No | which CDR definition decides what is grafted from the parental antibody. Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), north (North). | imgt |
| rankByFrameworks | No | rank germlines on framework identity alone, ignoring the CDRs. | |
| backmutateVernier | No | keep the parental residues at the Kabat Vernier positions, the framework residues that support the CDR loops. |
Output Schema
| Name | Required | Description |
|---|---|---|
| grafted | Yes | the grafted variable domain sequence |
| germline | Yes | the V and J alleles the frameworks came from |
| identity | Yes | percent identity of the grafted domain to the parental one |
| candidates | Yes | the closest human V and J germlines, best first |
history_protocolBRead-onlyInspect
Render a construct's build history into a numbered bench-recipe protocol.
| Name | Required | Description | Default |
|---|---|---|---|
| root | Yes | a history-node tree. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| protocol | Yes | numbered bench-recipe protocol text |
humanize_antibodyARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| domain | No | which variable domain to humanize when the sequence holds several (0-based, in sequence order). | |
| protein | Yes | the protein sequence (one-letter amino acids); the variable domains in it are found and numbered first. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| iterations | No | Sapiens passes, each re-scoring the previous output (BioPhi's default 1). | |
| humanizeCdrs | No | humanize the CDRs too instead of grafting the parental ones back (raises the risk of losing binding). | |
| cdrDefinition | No | which CDR definition marks the residues kept from the parental antibody. Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), north (North). | imgt |
| backmutateVernier | No | also keep the parental residues at the Kabat Vernier positions, which support the CDR loops. |
Output Schema
| Name | Required | Description |
|---|---|---|
| identity | Yes | percent identity of the humanized domain to the parental one |
| humanized | Yes | the humanized variable domain sequence |
| mutations | Yes | each change: 0-based index in the domain, IMGT position, region, parental and humanized residue, and the model's probability for each |
| mutationCount | Yes | number of positions changed |
infer_proteinsBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| psms | Yes | the matches as a table with a header row naming spectrum, peptide, charge and score (tab- or comma-separated); peptides are ProForma. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| database | Yes | the protein database searched, as FASTA; the accession is the header up to the first space. | |
| coverageOf | No | the accession whose sequence coverage is drawn; empty draws the first protein of the best group, as the Coverage tab opens on. | |
| aggregation | No | how a protein's peptide scores combine: best one, mean (sum over count), or product. | best |
| minPeptides | No | report only proteins with at least this many evidences (0 reports every matched protein). | |
| scoreColumn | 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. | score |
| ilEquivalent | No | treat isoleucine and leucine (and a database J) as the same residue when mapping peptides. | |
| scoresArePep | 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. | |
| higherIsBetter | No | true for scores like HyperScore; false for e-values, q-values and PEPs. | |
| useSharedPeptides | No | let a peptide that maps to several proteins count for each of them. | |
| maxAmbiguousResidues | No | how many ambiguous database residues (B, J, Z, X) one peptide match may resolve. | |
| greedyGroupResolution | 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. | |
| chargeVariantsSeparate | No | count each charge state of a peptide as its own evidence. | |
| peptideProteinResolution | 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 is reported as an ambiguity group; not combined with greedyGroupResolution. | |
| modificationVariantsSeparate | No | count each modified form of a peptide as its own evidence. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | proteins reported |
| groups | Yes | indistinguishable protein groups, best first: probability (the best member score) and accessions |
| method | Yes | the inference algorithm and mapping that produced these proteins, named |
| proteins | Yes | one row per protein: accession, score, evidences counted, sequence coverage (%) |
| coverageMap | Yes | one protein's sequence with the peptides that identified it laid under the residues they cover, unique in blue and shared in orange: the Coverage tab's picture of `coverageOf` |
| scoreColumn | Yes | the column the match scores were read from, which decides whether higher or lower is better |
| ambiguityGroups | Yes | with peptide–protein resolution: one group per connected set of groups, best group first, with the best probability. Null when that resolution was not asked for, because an empty list would read as a dataset with no ambiguity in it |
isotope_envelopeARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| charge | No | protons added; masses then include them (divide by the charge for m/z). | |
| formula | No | elemental formula of a neutral compound (C29H31N7O; isotopes as C[13]); give this or `sequence`. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | peptide, plain one-letter residues; give this or `formula`. | |
| maxIsotope | No | peaks to keep (M counts as one); 0 keeps every peak. |
Output Schema
| Name | Required | Description |
|---|---|---|
| peaks | Yes | one row per peak: isotope index, mass, relative abundance (sums to 1) |
isotopic_compositionBRead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | Yes | peptide, plain one-letter residues. |
Output Schema
| Name | Required | Description |
|---|---|---|
| abundance | Yes | relative abundance of that composition (0-1) |
| composition | Yes | element -> isotope mass number -> atom count |
ligate_fragmentsCInspect
Ligate fragments by their overhangs (pydna ligation_assembly) — sticky, optionally blunt.
| Name | Required | Description | Default |
|---|---|---|---|
| blunt | No | allow blunt-end joins as well as sticky. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | No | digest every input with these enzymes before ligating. Left unset, the run uses your active enzyme collection. | |
| fill_in | 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 | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| fragments | No | the fragments to ligate — wire upstream `record` outputs here, or name library documents. | |
| end_origins | 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 chemistry at all. Advanced. | |
| circular_only | No | report only circular products. | |
| end_treatments | 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 bond and the product is dropped. Advanced. | |
| include_subject | No | also include the node's subject as a fragment. | |
| fragment_indices | 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. | |
| allow_partial_overlap | No | allow partially overlapping sticky ends. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| layout | Yes | where each piece and join sits ON the product: the spans the map draws |
| record | Yes | the first ligation product, as a record |
| products | Yes | every product |
| junctions | Yes | the junctions formed, with the overhang each was made by |
| productCount | Yes | number of products (>1 = ambiguous ligation) |
| nickedJunctions | Yes | indices of junctions left NICKED by a missing 5'-phosphate on one strand — the product still transforms and is repaired in vivo. Empty when every junction sealed |
ligation_independent_cloneBInspect
Join fragments without a ligase by one of the five named methods — LIC, SLIC, In-Fusion, CPEC or USER (pydna).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| arm_nt | 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. | |
| method | 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), user (USER). | in-fusion |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| fragments | No | the fragments to join — wire upstream `record` outputs here, or name library documents. | |
| circular_only | No | report only circular products. | |
| include_subject | No | also include the node's subject as a fragment. |
Output Schema
| Name | Required | Description |
|---|---|---|
| arm | Yes | the homology arm the run used |
| record | Yes | the first product, as a record |
| summary | Yes | what the reaction gave, naming the method and its chemistry |
| products | Yes | every product |
| armVerdict | Yes | whether that arm is one the method's authority stands behind, in its own words |
| productCount | Yes | number of products (>1 = ambiguous) |
linkage_disequilibriumARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | last position (1-based) of the window; 0 is the last site. | |
| vcf | Yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. | |
| group | No | compute over this group's samples only; empty is every sample. | |
| start | No | first position (1-based) of the window; 0 is the first site. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| minMac | No | keep sites where REF and the first ALT are each seen at least this many times (scikit-allel is_biallelic_01 min_mac). | |
| groupBy | No | which column of the sample table groups the samples; empty is its first grouping column. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| maxSites | No | refuse more sites than this: the pair count grows with its square. | |
| estimator | 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 dosages)), haplotype (Haplotype r² and D′ (maximum likelihood)). | rogersHuff |
| pruneSize | No | LD pruning window, in sites (locate_unlinked size). | |
| pruneStep | No | sites the pruning window advances (locate_unlinked step). | |
| populations | 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. | |
| pruneThreshold | No | prune the later site of a pair whose Rogers–Huff r² exceeds this (locate_unlinked threshold). |
Output Schema
| Name | Required | Description |
|---|---|---|
| pairs | Yes | condensed upper triangle, pair (i, j > i) in row order: r (rogersHuff) or [r², D′] (haplotype), null where a site is monomorphic among the samples called at both |
| sites | Yes | the sites compared, in order: index into the call set, chrom, pos, ref, alt, and whether pruning kept it |
| summary | Yes | sites, pairs, mean r², pairs at r² ≥ 0.8, pruning kept, and the strongest pairs |
list_databasesBRead-onlyInspect
The authoritative databases available, with what each one covers, whether it is reachable from the browser, and any license or coverage caveat.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| domain | No | restrict to one subject area (all areas when unset). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many authorities the filter left |
| sources | Yes | every authority in the requested domain: its id, what it covers, its measured browser transport verdict, and any license or coverage caveat |
list_experimentsARead-onlyInspect
Your lab-notebook entries, newest first — id, title, tags, collection, when they changed, and the @plasmid / !action / &gel cross-references each one names.
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | only entries carrying this tag. | |
| limit | No | how many entries to return, newest first. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| search | No | match on title or body text, case-insensitively. Left unset, every entry is listed. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| collection | No | only entries filed in this collection. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many matched — branch on this rather than counting the array |
| total | Yes | how many entries the notebook holds in all, so a filter that matched nothing can say whether the notebook is empty or the filter was wrong |
| entries | Yes | the matching entries: id, title, tags, collection, created_at, updated_at, the three cross-reference lists and the body length. The BODY itself is not here — a notebook is long and a listing is for finding, so read one with the id this gives you |
| collections | Yes | every collection you have, with how many entries it holds |
list_libraryARead-onlyInspect
List the project's sequence documents (id, name, length, topology, kind).
| Name | Required | Description | Default |
|---|---|---|---|
| kind | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| ids | Yes | just the entry ids, in the same order — the list to scatter a per-document step over |
| count | Yes | number of entries |
| items | Yes | the library entries |
| names | Yes | just the entry names, in the same order |
list_research_runsARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| runs | No | the run files to list; in the app, left unset, the research runs this project holds. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| runs | Yes | one row per run whose seal holds: id, hypotheses, supported, not supported, without evidence, pending, settled, canceled, inputs pinned and the next action |
| count | Yes | how many runs opened under their seal |
| refused | Yes | each file whose seal failed, by position, with the reason |
list_samplesBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| kind | 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 | No | most entries to return; `total` says how many matched. | |
| query | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| ids | Yes | just the ids, in the same order — the list to scatter a per-sample step over |
| total | Yes | how many entries matched before `limit` was applied |
| samples | Yes | the matching entries: id, name, category, format, label, kind, size and provenance when recorded |
list_sgrna_scaffoldsARead-onlyInspect
Every sgRNA scaffold this workbench has sourced, with the nucleases each covers and the publication it comes from.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many scaffolds are shipped |
| scaffolds | Yes | each scaffold: id, name, sequence, length, which side of the spacer it sits, the nucleases it covers, its citation and accessions |
list_tracesARead-onlyInspect
List the Sanger trace files in this project (.ab1 / .abi / .scf / .ztr) — the list a batch runs over.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| ids | Yes | their project file ids, in the same order (unambiguous where two names match) |
| count | Yes | how many traces that is |
| names | Yes | the trace file names, in project order — the list to scatter a trace reader over |
list_workflow_templatesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | one template id; omit for the whole listing |
load_recordARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | Yes | the project document to read — its id, or its exact name (`list_library` lists them). |
Output Schema
| Name | Required | Description |
|---|---|---|
| name | Yes | document name |
| length | Yes | length in bp |
| record | Yes | the chosen document as a record (subject for downstream nodes) |
| circular | Yes | topology (true = circular) |
| sequence | Yes | the sequence 5'→3' |
load_traceBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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. | |
| min_quality | No | the mean phred a window must reach to be kept when trimming. Only applies when trim is true. | |
| reverse_complement | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| trace | Yes | what the FILE says about itself: format, instrument comments, call count, trim bounds. Not the signal, which cannot ride a wire |
| length | Yes | how many bases that is |
| record | Yes | the read as a linear record, ready for any downstream step |
| sequence | Yes | its bases, trimmed when trimming is on |
| ambiguous | Yes | how many calls are not A, C, G or T: the mixed positions |
| qualities | Yes | per-base phred, parallel to the bases |
| meanQuality | Yes | the ARITHMETIC mean of the per-base phred, which is what FastQC plots. Always the higher of the two, because a phred score is a log of an error rate: keep it for comparison with other tools, gate on readQuality |
| qualityPlot | Yes | per-base phred as a plot along the read, with Q20 (1 error in 100) marked |
| readQuality | Yes | the read's own quality: the phred of its MEAN ERROR PROBABILITY, which is what seqkit's --avg-qual reports. Wire THIS into a gate to stop a bad read early |
| expectedAccuracy | Yes | the same number as a percentage of bases expected to be correct |
lookup_clinicalARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | maximum records (1–20). | |
| query | Yes | a drug, gene, disease or trial id, or a command such as "clingen_gene_validity:BRCA2". | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| source | Yes | which authority to ask. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many records came back, which is a result even when it is zero |
| records | Yes | the records the authority returned, in its own field names — wire them into a tool that takes ids, or read them in the transcript |
| envelope | Yes | the authority's whole answer: paging, totals and the query it actually ran |
| provenance | Yes | the authority, the exact endpoints called and when — what makes an answer re-checkable without re-running it |
lookup_compoundARead-onlyInspect
Look up a chemical compound or drug: ChEMBL molecules, mechanisms of action and bioactivity, PubChem properties, ChEBI ontology, Rhea reactions, or purchasable ZINC compounds.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | maximum records (1–20). | |
| query | Yes | a compound name, SMILES or identifier, or a command such as "mechanism:CHEMBL941" or "admet:CHEMBL941". | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| source | Yes | which authority to ask. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many records came back, which is a result even when it is zero |
| records | Yes | the records the authority returned, in its own field names — wire them into a tool that takes ids, or read them in the transcript |
| envelope | Yes | the authority's whole answer: paging, totals and the query it actually ran |
| provenance | Yes | the authority, the exact endpoints called and when — what makes an answer re-checkable without re-running it |
lookup_geneBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | maximum records (1–20). | |
| query | Yes | a gene symbol or identifier (e.g. "BRCA2"), or a command such as "ensembl_lookup:BRCA2" or "ensembl_xrefs:ENSG00000139618". | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| source | Yes | which authority to ask. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many records came back, which is a result even when it is zero |
| records | Yes | the records the authority returned, in its own field names — wire them into a tool that takes ids, or read them in the transcript |
| envelope | Yes | the authority's whole answer: paging, totals and the query it actually ran |
| provenance | Yes | the authority, the exact endpoints called and when — what makes an answer re-checkable without re-running it |
lookup_omicsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | maximum records (1–20). | |
| query | Yes | an accession or search term, or a command such as "geo_get_series:GSE12345" or "encode_get_file:ENCFF002JUR". | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| source | Yes | which authority to ask. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many records came back, which is a result even when it is zero |
| records | Yes | the records the authority returned, in its own field names — wire them into a tool that takes ids, or read them in the transcript |
| envelope | Yes | the authority's whole answer: paging, totals and the query it actually ran |
| provenance | Yes | the authority, the exact endpoints called and when — what makes an answer re-checkable without re-running it |
lookup_ontologyARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | maximum records (1–20). | |
| query | Yes | a term, accession or command such as "get_go_annotations:P04637" or "map_reactome_pathways:TP53". | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| source | Yes | which authority to ask. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many records came back, which is a result even when it is zero |
| records | Yes | the records the authority returned, in its own field names — wire them into a tool that takes ids, or read them in the transcript |
| envelope | Yes | the authority's whole answer: paging, totals and the query it actually ran |
| provenance | Yes | the authority, the exact endpoints called and when — what makes an answer re-checkable without re-running it |
lookup_proteinBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | maximum records (1–20). | |
| query | 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 (its field projection has no sequence field), so to get the SEQUENCE ask for the entry by accession: "get_uniprot_entries:P60568" (FASTA, residues included), or add "format=tsv fields=accession,sequence" for a table. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| source | Yes | which authority to ask. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many records came back, which is a result even when it is zero |
| records | Yes | the records the authority returned, in its own field names — wire them into a tool that takes ids, or read them in the transcript |
| envelope | Yes | the authority's whole answer: paging, totals and the query it actually ran |
| provenance | Yes | the authority, the exact endpoints called and when — what makes an answer re-checkable without re-running it |
lookup_residue_sitesBRead-onlyInspect
The individual catalytic, substrate-binding, metal-binding and interface residues a member database annotates INSIDE a domain, for a known protein.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| accession | 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 residue on the wrong amino acid. |
Output Schema
| Name | Required | Description |
|---|---|---|
| signatures | Yes | per member-database signature: its accession, the database, its name, and each named site with every annotated residue and 1-based position |
| residueCount | Yes | total annotated residues across every signature |
lookup_variantBRead-onlyInspect
Look up a variant: ClinVar clinical interpretation, dbSNP records, gnomAD population frequency and gene constraint, CADD deleteriousness, or GWAS/eQTL associations.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | maximum records (1–20). | |
| query | 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, because its summary statistics are indexed by position and its REST API is retired: "eqtl_list_datasets tissue_label=macrophage" to pick a dataset, then "eqtl_associations dataset_id=QTD000021 region=1:109274570-109279000 gene_id=ENSG00000134243". | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| source | Yes | which authority to ask. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many records came back, which is a result even when it is zero |
| records | Yes | the records the authority returned, in its own field names — wire them into a tool that takes ids, or read them in the transcript |
| envelope | Yes | the authority's whole answer: paging, totals and the query it actually ran |
| provenance | Yes | the authority, the exact endpoints called and when — what makes an answer re-checkable without re-running it |
map_chemical_spaceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| space | No | what the components are taken over. Values: descriptors (Properties (scaled)), morgan (Morgan bits (ECFP4)). | descriptors |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| molecules | Yes | the structures: one SMILES or molfile per entry. |
Output Schema
| Name | Required | Description |
|---|---|---|
| points | Yes | per mapped structure: its index and its PC1 and PC2 scores |
| summary | Yes | the map in words, generated from this run |
| explained | Yes | the share of the total variance each component carries |
map_reaction_atomsCRead-onlyInspect
Predict which reactant atom each product atom came from (atom-to-atom mapping) with RXNMapper (Schwaller et al., Sci.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| reaction | Yes | reaction SMILES, reactants>agents>products; existing atom maps are ignored. |
Output Schema
| Name | Required | Description |
|---|---|---|
| mapped | Yes | the canonicalised reaction SMILES with atom maps |
| confidence | Yes | the product of the per-atom confidences, 0 to 1 |
map_readsBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| k | No | k-mer size of the minimizer seeds (`-k`). Advanced. | |
| w | No | minimizer window (`-w`): one seed kept per this many consecutive k-mers. Advanced. | |
| depth | No | per-base read depth of the SAM written (`samtools depth`): off; every position inside some read's span (an intron or deletion inside a read prints 0); or every position of each reference a read landed on (`-a`). Reads that are unmapped, secondary, QC-failed or duplicate are not counted. Values: none (Off), covered (Covered positions), all (Every position (-a)). | none |
| mates | No | mate-2 reads, pairing record for record with `reads`. Empty maps the reads single-end. | |
| reads | Yes | the reads: FASTQ (quality kept in the SAM) or FASTA (QUAL written as `*`). | |
| zdrop | No | Z-drop (`-z`): stop extending when the score falls this far below its best, which clips a read at a junction instead of forcing it through. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| md_tag | No | write MD tags (`--MD`); the consensus uses them to trust reads with edits nearby less. | |
| preset | 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. Values: sr (Short reads), splice:sr (Short RNA-seq reads), splice (Long RNA reads, cDNA), splice:hq (Accurate long RNA reads), map-ont (Nanopore), lr:hq (Accurate long reads), map-hifi (PacBio HiFi), map-pb (PacBio CLR), map-iclr (Illumina Complete Long Reads), lr:hqae (Assembly evaluation), asm5 (Assembly, ~0.1% divergent), asm10 (Assembly, ~1% divergent), ava-pb (PacBio all-vs-all overlaps), ava-ont (Nanopore all-vs-all overlaps), asm20 (Assembly, several % divergent). | sr |
| max_gap | No | a chain stops at a gap longer than this between seeds (`-g`). In bp. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| gap_open | No | gap-open penalty of the short-gap cost (`-O`, first value). Advanced. | |
| variants | No | call SNVs and indels from the SAM written (`bcftools mpileup | bcftools call -mv`): genotype, quality, allelic depths and strand counts per site, as VCF. | |
| bandwidth | 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. | |
| consensus | No | the sample's sequence called from the reads over the reference (`samtools consensus`); N where no call is confident. Values: off (Off), fasta (FASTA), fastq (FASTQ (with quality)), pileup (Pileup (every column)). | off |
| end_bonus | No | bonus for reaching the read's end (`--end-bonus`); higher prefers end-to-end alignment over soft-clipping. Advanced. | |
| reference | No | what to map against: bases, or a FASTA with one or more records. Unset, it is the record this step runs on. | |
| gap_extend | No | per-base extension of the short-gap cost (`-E`, first value). Advanced. | |
| max_intron | No | longest intron an alignment may span (`-G`); it also sets the reference gap and both chaining bands, as minimap2 does. In bp. Only applies when preset is splice or splice:hq or splice:sr. Advanced. | |
| markdup_tag | No | tag each duplicate with the name of the read it copies (`do:Z`, `-t`). Only applies when mark_duplicates is true. | |
| match_score | No | score per matching base (`-A`). Advanced. | |
| markdup_mode | No | what makes two reads duplicates (`-m`): the template's two outer ends (samtools' default, as Picard), or each read's start by strand. Values: t (Template ends), s (Read starts). Only applies when mark_duplicates is true. | t |
| min_dp_score | No | lowest peak alignment score kept (`-s`). | |
| variants_baq | No | recalibrate base qualities by their alignment uncertainty near indels (BAQ, bcftools' default; off is `-B`). Only applies when variants is true. | |
| gap_open_long | No | gap-open penalty of the long-gap cost (`-O`, second value); a gap costs the cheaper of the two. Advanced. | |
| max_secondary | No | most secondary placements kept per read (`-N`). | |
| output_format | No | SAM (`-a`, every read with its alignment) or PAF (minimap2's default: one line per hit, no read sequence). Unset: PAF for the all-vs-all presets, SAM otherwise. Values: sam (SAM), paf (PAF). | |
| variants_args | No | further `bcftools mpileup` options (`--max-BQ`, `--delta-BQ`, `--ff`, `-M`, `-E`). Only applies when variants is true. | |
| bandwidth_long | 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. Advanced. | |
| base_alignment | No | in PAF, align base by base (`-c`): exact ends, CIGAR as `cg:Z`, NM. Off, a hit's coordinates are its chain's ends, which is much faster. SAM always aligns. Only applies when output_format is paf. | |
| consensus_args | No | further `samtools consensus` options, applied last (e.g. `--min-MQ 20 -t :hiseq`); all but files and threads. Only applies when consensus is fasta or fastq or pileup. | |
| consensus_mode | No | how a column is called (`-m`). Values: bayesian (Bayesian), bayesian_p (Bayesian, precise), bayesian_m (Bayesian, blended), bayesian_116 (Bayesian (samtools 1.16)), simple (Simple counting). Only applies when consensus is fasta or fastq or pileup. | bayesian |
| markdup_remove | No | remove the duplicates from the SAM instead of flagging them (`-r`). Only applies when mark_duplicates is true. | |
| min_minimizers | No | fewest seeds a chain may have (`-n`). Advanced. | |
| variants_prior | No | the mutation-rate prior (`call -P`): higher calls more sites. Only applies when variants is true. | |
| gap_extend_long | No | per-base extension of the long-gap cost (`-E`, second value). Advanced. | |
| mark_duplicates | No | mark PCR and optical duplicates (`samtools fixmate -m`, `sort`, `markdup`): reads whose 5′ ends, strands and mate position match are copies of one fragment; the best by base quality is kept and the rest flagged 0x400. The SAM comes back sorted by coordinate, and flagstat, coverage and depth then count the flags. | |
| min_chain_score | No | lowest chaining score kept (`-m`), roughly the number of matching bases the seeds cover. | |
| secondary_ratio | No | a secondary placement is kept when its score is at least this fraction of the primary's (`-p`). | |
| variants_indels | No | call indels too, with bcftools' default indel model (off is `-I`, SNVs only). Only applies when variants is true. | |
| write_secondary | No | also write secondary records to the SAM (`--secondary=yes`); off, they are counted but not written, as minimap2 does for short reads. | |
| zdrop_inversion | No | Z-drop at which a stalled long alignment is tested for an inversion (`-z`, second value); an inverted segment found there is written as its own record. Advanced. | |
| consensus_region | No | one region (`-r`): name or name:start-end, 1-based. Only applies when consensus is fasta or fastq or pileup. | |
| mismatch_penalty | No | penalty per mismatch (`-B`). Advanced. | |
| consensus_profile | No | a platform's quality calibration and tuned parameters (`-X`). Values: none (None), hiseq (Illumina HiSeq), hifi (PacBio HiFi), r10.4_sup (Nanopore R10.4 simplex (sup)), r10.4_dup (Nanopore R10.4 duplex), ultima (Ultima Genomics). Only applies when consensus is fasta or fastq or pileup. | none |
| variants_full_baq | No | run BAQ on every read at a column with an indel, not only the reads it is likely to change (`-D`; nothing with BAQ off). Only applies when variants is true. | |
| variants_gap_open | No | phred-scaled probability that sequencing opens a gap (`-o`); lower calls more indels. Only applies when variants is true. | |
| transition_penalty | No | penalty for a transition (A↔G, C↔T) mismatch (`-b`); 0 scores it as any mismatch. Illumina Complete Long Reads use 4. Advanced. | |
| variants_adjust_mq | No | cap the mapping quality of reads with many high-quality mismatches (`-C`; 50 for BWA reads, 0 is off, values up to 10 do nothing). Only applies when variants is true. | |
| variants_max_depth | No | most reads piled up per position (`-d`); at most 255, where bcftools starts downsampling at random. Only applies when variants is true. | |
| consensus_ambiguity | No | a heterozygous call as its IUPAC code (`-A`). Only applies when consensus is fasta or fastq or pileup. | |
| consensus_min_depth | No | fewer usable reads than this is N (`-d`). Only applies when consensus is fasta or fastq or pileup. | |
| consensus_positions | No | which positions are written. Values: covered (Covered span), reference (Whole reference (-a)), all (Every reference (-aa)). Only applies when consensus is fasta or fastq or pileup. | covered |
| max_fragment_length | No | longest fragment (insert) two mates may span and still pair (`--frag`/`-I`). In bp. Only applies when mates is set. | |
| max_seed_occurrence | 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. | |
| variants_gap_extend | No | phred-scaled probability that sequencing extends a gap (`-e`). Only applies when variants is true. | |
| variants_indel_bias | No | raise to favour indel recall over precision (`--indel-bias`). Only applies when variants is true. | |
| variants_indel_size | No | approximate largest indel considered, in bases (`--indel-size`, at least 20). Only applies when variants is true. | |
| noncanonical_penalty | No | cost of a splice site that is not GT..AG, GC..AG or AT..AC (`-C`). Only the splice presets align across introns. Only applies when preset is splice or splice:hq or splice:sr. Advanced. | |
| variants_homopolymer | No | how strongly a homopolymer run lowers an indel's quality (`-h`); lower trusts indels in runs less. Only applies when variants is true. | |
| depth_count_deletions | No | count a read's deletions toward the depth under them (`-J`); off, a deleted base is not covered by that read. Only applies when depth is covered or all. | |
| depth_min_read_length | No | a read with fewer aligned bases than this (soft clips excluded) does not count (`-l`). In bp. Only applies when depth is covered or all. | |
| depth_remove_overlaps | No | count the overlap of a read pair once (`-s`): the second mate starts counting where the first ended. Only applies when depth is covered or all. | |
| markdup_supplementary | No | also flag the supplementary, secondary and unmapped records of a duplicate (`-S`). Only applies when mark_duplicates is true. | |
| depth_min_base_quality | No | a base below this quality does not count (`-q`). Only applies when depth is covered or all. | |
| homopolymer_compressed | 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. | |
| variants_count_orphans | No | keep reads paired but not properly paired (`-A`). Only applies when variants is true. | |
| variants_keep_reference | No | also write the positions where the reads agree with the reference (`call -m` without `-v`): one record per covered position, variant or not. Only applies when variants is true. | |
| consensus_fill_reference | No | the reference's base where no read gives one (`-T`), instead of N. Only applies when consensus is fasta or fastq or pileup. | |
| consensus_show_deletions | No | write a deletion as `*` (`--show-del`). Only applies when consensus is fasta or fastq or pileup. | |
| markdup_optical_distance | No | also call a duplicate optical when its Illumina tile x/y lies within this many pixels of the original's (`-d`); 0 is off. Illumina suggests 100 for unpatterned flow cells and 2,500 for patterned ones. In px. Only applies when mark_duplicates is true. | |
| variants_max_indel_depth | No | positions this deep or deeper get no indel call (`-L`). Only applies when variants is true. | |
| variants_min_indel_reads | No | fewest reads carrying an indel for it to be considered (`-m`). Only applies when variants is true. | |
| consensus_show_insertions | No | write inserted bases (`--show-ins`). Only applies when consensus is fasta or fastq or pileup. | |
| depth_min_mapping_quality | No | a read below this mapping quality does not count (`-Q`). Only applies when depth is covered or all. | |
| variants_min_base_quality | No | skip bases below this quality (`-Q`). Only applies when variants is true. | |
| variants_min_indel_fraction | No | smallest fraction of reads carrying an indel for it to be considered (`-F`). Only applies when variants is true. | |
| variants_overlap_adjustment | No | where two mates overlap, count the shared bases once by zeroing one mate's qualities (off is `-x`). Only applies when variants is true. | |
| variants_min_mapping_quality | No | skip reads below this mapping quality (`-q`). Only applies when variants is true. |
Output Schema
| Name | Required | Description |
|---|---|---|
| paf | Yes | the hits as PAF, as minimap2 writes it by default (empty when the output is SAM); for the all-vs-all presets, every overlap between two reads |
| sam | Yes | the alignment as SAM text (header + records), as `minimap2 -ax <preset>` writes it. Open it in the pileup, or hand it to a variant caller |
| vcf | Yes | SNVs called from the SAM written, as `bcftools call -mv` writes the VCF (GT, PL, AD; DP, DP4, MQ and the bias tests per site). Empty unless `variants` is on. Open it in the variant viewer |
| calls | Yes | each call: contig, position, reference and alternate alleles, QUAL, genotype, depth, DP4, allelic depths, PL and mean mapping quality. Empty unless `variants` is on |
| depth | Yes | `samtools depth` of the SAM written, as samtools prints it (reference, 1-based position, depth; one line per position). Empty unless `depth` asks for it |
| mapq0 | Yes | mapped reads with MAPQ 0: placed, but with an equally good placement elsewhere |
| stats | Yes | every count: reads, fragments, mapped, unmapped, MAPQ bins, proper pairs, supplementary and secondary placements, reads spanning an intron, and per reference its reads and covered bases |
| mapped | Yes | reads with a primary placement |
| markdup | Yes | `samtools markdup`'s statistics when duplicates were marked: reads examined, pairs and singles, duplicate pairs and singles, optical duplicates, and the estimated library size. Empty otherwise |
| options | Yes | every minimap2 option the run used, with its flag, the preset value, and whether it was changed |
| reading | Yes | what the run found, generated from its counts: the conclusion, then each qualifier the run earned |
| coverage | Yes | `samtools coverage` of the SAM written: per reference its reads, covered bases, percent covered, mean depth, mean base quality and mean mapping quality (reads that are unmapped, secondary, QC-failed or duplicate excluded, as samtools does). Null for PAF output, which writes no SAM to summarize |
| flagstat | Yes | `samtools flagstat` of the SAM written, as samtools prints it (QC-passed + QC-failed: total, primary, secondary, supplementary, duplicates, mapped, paired, properly paired, singletons, mates on another reference). Empty for PAF. Null for PAF output, which writes no SAM to summarize |
| unmapped | Yes | reads with none |
| consensus | Yes | `samtools consensus` of the SAM written, as samtools prints it (FASTA, FASTQ or pileup). Empty unless `consensus` asks for it |
| junctions | Yes | splice junctions as `minimap2 --write-junc` writes them (BED-like: reference, start, end, read, motif score, strand; one line per intron per read, primary alignments of MAPQ 10 or more). Empty outside the splice presets |
| meanIdentity | Yes | mean identity of primary alignments, matching bases over aligned columns (0–1). Null when no read aligned, so there is nothing to measure: a 0 would read as every base mismatched |
| junctionTable | Yes | each distinct junction once: reference, start, end, strand, motif score (6 = GT..AG) and the number of reads that support it |
| properlyPaired | Yes | reads in a proper pair (0 when mapped single-end) |
| variantSummary | Yes | the calls counted: SNVs, indels, homozygous and heterozygous, transitions and transversions among the SNVs, covered positions, and the bcftools command used |
| consensusSummary | Yes | the consensus counted: sequences, bases, N (no call), IUPAC ambiguity codes, lower-case and deletion calls, mean quality, and the samtools arguments used |
mask_sequenceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| hicut | No | SEG's K2, the extension complexity in bits. Only applies when masker is seg. | |
| level | No | DUST's T. Higher masks less. Only applies when masker is dust. | |
| locut | No | SEG's K1, the trigger complexity in bits. Only applies when masker is seg. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| masker | 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). | dust |
| window | No | the scored window's width. 0 takes each masker's own default. | |
| context | 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 the organism. Only applies when masker is windowmasker. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the sequence to mask. Wire a record or a sequence output, or paste it. Left empty, the open record is used. | |
| unit_size | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| masked | Yes | the sequence soft-masked (lower case), which is what BLAST reads as masked |
| intervals | Yes | the masked stretches, 0-based inclusive |
| hardMasked | Yes | the sequence with the masked stretches replaced by N (or X for a protein) |
| provenance | Yes | the masker, the parameters it really used, and for WindowMasker the derived thresholds and the set they came from |
| maskedFraction | Yes | what share of the sequence was masked, 0 to 1. Wire into a $when to refuse a query that is mostly gone |
matched_molecular_pairsBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| max_size | No | largest changed part, in heavy atoms. | |
| molecules | Yes | the structures: one SMILES or molfile per entry. |
Output Schema
| Name | Required | Description |
|---|---|---|
| summary | Yes | the pairs in words, generated from this run |
| transformations | Yes | each change as SMIRKS with its pairs (left, right, shared context) |
match_part_by_sequenceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | most candidate sequences to fetch and compare before stopping and saying so. | |
| name | 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 slower and can be far more requests. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | Yes | the bases to identify — a feature’s span, an assembled fragment, a pasted oligo. |
Output Schema
| Name | Required | Description |
|---|---|---|
| page | Yes | the registry page, so the claim can be checked without us |
| part | Yes | the best match’s registry id, exact before reverse-complement |
| role | Yes | its Sequence-Ontology role, as the registry files it |
| title | Yes | the registry’s own short title for that part |
| strand | Yes | `exact` when the bases agree as given, `reverse-complement` when they agree flipped |
| licence | Yes | the SPDX identifier the registry states for that part |
| matched | Yes | whether any compared part carries these exact bases |
| matches | Yes | every part that carries these bases — several may, and the registry keeps them apart |
| coverage | Yes | what was and was not compared: the population at this length, the candidates the narrowing produced, how many were read back, and whether the cap stopped it. A null answer is only as strong as this. |
| description | Yes | the registry’s own prose — the half a coordinate cannot tell you |
melting_temperatureBRead-onlyInspect
The melting temperature of an oligo IN A BUFFER, UNDER A MODEL — and the working, not just the number.
| Name | Required | Description | Default |
|---|---|---|---|
| model | 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, Breslauer 1986) · nn_rna_xia (RNA/RNA, Xia 1998) · nn_rna_chen (RNA/RNA, Chen 2012 (GU wobble)) · nn_rna_freier (RNA/RNA, Freier 1986) · nn_hybrid_sugimoto (RNA/DNA hybrid, Sugimoto 1995) · bresluc_dbd (Breslauer (dsDNA-binding polymerase)) · gc (GC-based (Tm_GC)) · wallace (Wallace rule (2·AT + 4·GC)) · neb (NEB). Advanced. | nn_unified |
| oligo | 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 toward the length. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| conditions | 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 reaction-conditions settings, which is what the Melting Temperature panel is showing, so the two doors cannot quote different temperatures for one oligo. Advanced. | |
| dmso_method | 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 (1980), 0.675 °C per %). Only read when the conditions carry DMSO. Only applies when dmso is set. Advanced. | ahs01 |
Output Schema
| Name | Required | Description |
|---|---|---|
| gc | Yes | GC content [%] of the oligo, weighted for ambiguity codes |
| tm | Yes | melting temperature [°C] after every correction the conditions asked for |
| model | Yes | the model that produced it, named — never the id alone |
| steps | Yes | the derivation, one row per correction: the base model with its table and salt method, then each additive with the degrees it removed AND the published model that set the coefficient — the same rows the panel prints, from the same generator |
| baseTm | Yes | the temperature BEFORE any additive, so a pipeline can see what DMSO or formamide cost rather than inferring it |
| caveat | Yes | why this model's number should not be read for an oligo of this length, or empty when it can be — Wallace above its published 14–20 nt domain is the case this exists for |
| lockedBases | Yes | how many bases of this oligo were read as LOCKED (LNA). 0 for ordinary DNA, so a pipeline can tell whether McTigue's increments were in play without parsing the steps |
| thermodynamics | Yes | ΔH, ΔS and ΔG(37 °C) from the SAME table as the temperature, so a row never mixes two models. Absent for models that carry no nearest-neighbor table (GC formula, Wallace, NEB) |
melt_profileARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| ions | No | molar sodium-equivalent concentration. Defaults to DECIPHER's own 0.2 M; the editor substitutes the project's shared Na⁺ instead. In M. | |
| step | No | grid spacing; finer costs proportionally more. In °C. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| max_temp | No | highest temperature to evaluate. In °C. | |
| min_temp | No | lowest temperature to evaluate. In °C. | |
| region_end | No | 0-based inclusive end. Unset = the whole sequence. Advanced. | |
| region_start | No | 0-based inclusive start of the region to melt. Unset = the whole sequence; pass the selection's start to scope to it. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| tm50 | Yes | temperature where mean helicity crosses 0.5 (null if the range never crosses it) |
| curve | Yes | mean helicity per temperature |
| hrmPlot | Yes | the HRM trace as a plot: −dθ/dT against temperature, one peak per melting domain |
| meltPlot | Yes | the melt curve as a plot: mean helicity against temperature |
| derivative | Yes | −dθ/dT, the HRM trace |
| domainCount | Yes | number of cooperatively-melting domains |
| transitions | Yes | melting domains (one peak each) |
miqe_checklistBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| answers | 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 validated DNA-free"}}. Ids run section.item over the paper's order (1 Reagent preparation · 2 Sample preparation · 3 Reverse transcription · 4 qPCR protocol · 5 Data analysis). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| tsv | Yes | the checklist as tab-separated text under the paper's own column headers, for a journal submission |
| rows | Yes | one row per item, in the paper's order: section, id, item, footnotes, provided, description, and the gap footnote b would still send back |
| notes | Yes | the table's footnotes by letter, which qualify the items that carry them |
| total | Yes | items in the checklist |
| reading | Yes | what is answered and what is still owed, generated from the answers |
| answered | Yes | items answered yes or no |
| incomplete | Yes | answers without the location (yes) or reason (no) the checklist asks for |
multiplex_pcrBRead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| pool | No | also partition the screened reactions into compatible tubes (MultiPLX grouping), judged by the preset and cutoffs below. | |
| limit | No | minimum 3' footprint match for a primer to be considered bound (pydna's own default is 16). In bp. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| primers | No | the primer pool — literal sequences, or wire primer outputs from upstream design nodes. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| max_size | No | largest product to report. In bp. | |
| min_size | No | smallest product to report. In bp. | |
| templates | No | extra templates to screen against — wire records or name library documents (the subject is included by default). | |
| conditions | 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 reaction-conditions settings, so this node and the PCR panel describe ONE tube; with neither it falls back to pydna's Taq defaults, which is what every golden was captured under. Advanced. | |
| max_groups | No | most tubes the pool may be split into. Only applies when pool is true. | |
| cutoffs_off | No | cutoffs to switch off (not applied at all), whatever the preset says. Only applies when pool is true. Advanced. | |
| pool_preset | 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. | normal |
| max_per_group | No | most reactions one tube may hold. Only applies when pool is true. | |
| include_subject | No | screen against the node's subject as a template. | |
| cutoff_max_tm_diff | No | Primer Tm spread [°C]: Largest primer Tm difference allowed inside a tube: one annealing temperature has to work for every reaction in it. Unset keeps the preset's value. In °C. Only applies when pool is true. Advanced. | |
| cutoff_prim_prim_any | 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 pool is true. Advanced. | |
| cutoff_prim_prod_any | 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_prim_prim_end1 | 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 pool is true. Advanced. | |
| cutoff_prim_prim_end2 | 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/mol. Only applies when pool is true. Advanced. | |
| cutoff_prim_prod_end1 | 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 is true. Advanced. | |
| cutoff_max_prod_len_diff | 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. | |
| cutoff_min_prod_len_diff | 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 applies when pool is true. Advanced. | |
| cutoff_max_prim_prim_any_tm | 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. Only applies when pool is true. Advanced. | |
| cutoff_max_prim_prim_end_tm | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| pools | Yes | with `pool` on: the tubes, the per-tube verification, and a refusal naming the limit and pair that forced it when no partition fits |
| dimerMap | Yes | the all-against-all dimer ΔG as a heatmap, the most stable structure each pair forms anywhere along the oligos |
| amplicons | Yes | every predicted product (which pair, which template, what size) |
| poolCount | Yes | with `pool` on: how many tubes the partition needed (0 when it refused) |
| crossDimers | Yes | all-against-all primer-dimer matrix, or null with fewer than two primers |
| diagnostics | Yes | pairs that discriminate the templates by product size |
| primerStats | Yes | per-primer binding counts, including off-target |
| ampliconCount | Yes | number of predicted products |
notebook_cross_refsARead-onlyInspect
Extract @plasmid / !action / &gel cross-references from a lab-notebook markdown body.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| body_md | Yes | the notebook entry body (markdown). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| gels | Yes | &gel references |
| actions | Yes | !action references |
| plasmids | Yes | @plasmid references |
number_antibodyARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| scheme | No | numbering scheme. Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), martin (Martin (enhanced Chothia)), aho (AHo), wolfguy (Wolfguy). | imgt |
| protein | Yes | the protein sequence (one-letter amino acids); may hold several domains, e.g. an scFv. | |
| species | No | species whose HMMs are preferred for the hit and whose germlines are searched (ANARCI's default: human and mouse). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| chainTypes | No | chain types to number: H, K, L (antibody); A, B, G, D (TCR). Others are still listed in the hit table. | |
| cdrDefinition | No | where CDR1-3 begin and end (abnumber's borders; North is read in Chothia numbering). Kabat, Chothia and North define H, K and L chains only; TCR domains keep IMGT's. Values: imgt (IMGT), kabat (Kabat), chothia (Chothia), north (North). | imgt |
| assignGermline | No | assign the closest V and J germline genes. | |
| bitScoreThreshold | No | minimum HMMER bit score for a domain to count (ANARCI's default 80). |
Output Schema
| Name | Required | Description |
|---|---|---|
| hits | Yes | every HMM hit over the threshold: id, E-value, bit score, start, end |
| domains | Yes | one entry per domain: chain type, species, sequence span, numbering as [position, residue] pairs, framework and CDR regions (0-based residue spans) under cdrDefinition, germlines |
| chainTypes | Yes | the chain type of each domain, in sequence order |
optimize_sequenceCInspect
Run the DnaChisel optimizer over the subject with real constraints/objectives (GC window, pattern avoidance, translation enforcement, …).
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | base seed for the alternatives — the same seed returns the same set. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| candidates | 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. | |
| objectives | No | DnaChisel objective specs — soft goals the solver maximises. Same `kind` values as constraints: EnforceTranslation, AvoidPattern, EnforceGCContent, AvoidHairpins, AvoidRareCodons, UniquifyAllKmers, CodonOptimize, EnforceSequence, AvoidChanges, EnforceChoice, EnforcePatternOccurence, AvoidStopCodons, EnforceMeltingTemperature, EnforceChanges, EnforceTerminalGCContent, SequenceLengthBounds, EnforceRbsStrength, AvoidHeterodimerization, AllowPrimer, EnforceRegionsCompatibility, AvoidMatches, AvoidBlastMatches. | |
| constraints | 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, EnforceGCContent, AvoidHairpins, AvoidRareCodons, UniquifyAllKmers, CodonOptimize, EnforceSequence, AvoidChanges, EnforceChoice, EnforcePatternOccurence, AvoidStopCodons, EnforceMeltingTemperature, EnforceChanges, EnforceTerminalGCContent, SequenceLengthBounds, EnforceRbsStrength, AvoidHeterodimerization, AllowPrimer, EnforceRegionsCompatibility, AvoidMatches, AvoidBlastMatches. | |
| randomization_threshold | 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. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| nEdits | Yes | nucleotides changed |
| record | Yes | the optimized sequence as a record |
| gcAfter | Yes | GC fraction after optimization |
| success | Yes | all hard constraints satisfied |
| caiAfter | Yes | CAI after optimization, or null when not computable (no codon table to score against): a 0 would read as the worst possible adaptation |
| distinct | Yes | how many of the candidates are DIFFERENT sequences — 1 means the problem has a single answer, not that the run failed. The engine omits it for a single-candidate run, where it is 1 by definition |
| sequence | Yes | the optimized sequence |
| gcProfile | Yes | windowed GC before and after, at each window's centre: the stretches the solver moved, which the two whole-sequence GC numbers average away |
| candidates | Yes | every alternative solution: its seed, sequence, edit count, GC and CAI — compare them before choosing. Empty unless `candidates` asks for more than one |
pcr_amplifyAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dmso | No | DMSO in the reaction, % (v/v) — depresses every primer Tm and therefore the annealing temperature. In %. Advanced. | |
| limit | No | min 3' footprint match length (pydna `limit`). In bp. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| forward | Yes | forward primer 5'→3'. | |
| reverse | Yes | reverse primer 5'→3'. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| nn_table | 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 (Allawi & SantaLucia 1997), DNA_NN4 (SantaLucia & Hicks 2004 (unified)), RNA_NN1 (Freier 1986 (RNA/RNA)), RNA_NN2 (Xia 1998 (RNA/RNA)), RNA_NN3 (Chen 2012 (RNA/RNA, GU wobble)), R_DNA_NN1 (Sugimoto 1995 (RNA/DNA hybrid)). Advanced. | DNA_NN4 |
| conditions | 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 reaction-conditions settings, so this node and the PCR panel describe ONE tube; with neither it falls back to pydna's Taq defaults, which is what every golden was captured under. Advanced. | |
| dmso_model | 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)), cul76 (Cullen and Bick (1976)), esc80 (Escara and Hutton (1980)). Only applies when dmso is set. Advanced. | ahs01 |
| end_length | 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. | |
| mismatches | 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. | |
| inner_forward | 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 | No | nested PCR: the inner reverse primer 5'→3'. Advanced. | |
| dimer_threshold | 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 — refit it on your own gel-scored pairs with `primerRocFit` rather than guessing one. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| record | Yes | the amplicon as a sequence record (subject for downstream nodes) |
| sequence | Yes | amplicon sequence 5'→3'. Empty when the pair made no product |
| conditions | Yes | the buffer every temperature here was measured in — salt, magnesium, dNTPs, oligo concentration, the salt-correction method and the NN table — or a note saying pydna's defaults were used |
| forwardTmC | Yes | forward primer melting temperature, under the table and additives set above |
| reverseTmC | Yes | reverse primer melting temperature |
| productCount | Yes | number of products (>1 = non-specific pair) |
| crossDimerTmC | Yes | the forward x reverse 3'-end cross-dimer temperature — the primer-dimer that extends into a band. 0 when no such dimer exists, and a value far below the 35 °C limit is still a real structure: this is the number to compare pairs on, because the boolean beside it only reports primer3's design cutoff |
| annealingTempC | Yes | annealing temperature for the first product, under the Taq convention. Null when the pair made no product |
| primerDimerRisk | Yes | true when the pair breaks one of primer3's own cross-dimer limits (35 °C at a 3' end, 45 °C anywhere) — branch a workflow on this rather than re-deriving it. FALSE IS NOT 'no dimer': those limits are primer3's design filter, and graded against 48 gel-tested pairs (Johnston et al., Sci Rep 9:209, 2019) they flag none of the 23 that produced a visible primer-primer band. Read `crossDimerTmC` beside it rather than branching on this alone |
| primerDimerScore | Yes | PrimerDimer's score for the pair (Johnston et al., Sci Rep 9:209, 2019: one hetero- and both homodimers, the most negative kept, clipped at 0). Lower is more dimer-prone. On 48 gel-tested pairs it separates real primer-dimer bands better than the thal Tm beside it (AUC 0.842 against 0.727), and on the paper's own 319 gel-scored pairs it reads 0.961 against 0.750. Read `primerDimerVerdict` beside it for the published cut-off rather than inventing a threshold. Null when a primer carries a base other than A, C, G or T |
| primerDimerCutoff | Yes | the dimer-free cut-off `primerDimerVerdict` was read against, so a turn never has to assume which threshold produced the verdict. -4.43 is the published value, fitted on the paper's own PCR conditions |
| primerDimerVerdict | Yes | true when `primerDimerScore` falls BELOW PrimerROC's dimer-free cut-off, which is the paper's own verdict rather than primer3's design filter (Johnston et al., Sci Rep 9:209, 2019). The cut-off defaults to the published -4.43 and is the `dimerThreshold` input: the paper fitted it on its own gels and says so, so a lab with its own gel data refits it with `primerRocFit`. Branch on this for the dimer question and on `primerDimerRisk` for the would-primer3-reject-this question — they answer different things. Null when a primer carries a base other than A, C, G or T |
| round1ProductCount | Yes | nested PCR only: how many products the OUTER pair made in round 1 (the first one is re-amplified). Absent for a single-round run |
peptide_massBRead-onlyInspect
Monoisotopic and average mass of a peptide, and its m/z at each charge state (validated against pyteomics).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| charges | No | charge states to report m/z for (positive integers). | |
| ionType | No | weigh the peptide as this ion; M is the intact molecule. Plain sequences only. | M |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | Yes | peptide: one-letter residues, optionally ProForma tags on residues and termini (a signed mass, a Unimod name, or UNIMOD:accession). |
Output Schema
| Name | Required | Description |
|---|---|---|
| mz | Yes | per charge: monoisotopic and average m/z |
| average | Yes | neutral average mass (Da); null for a peptidoform with modification tags |
| monoisotopic | Yes | neutral monoisotopic mass (Da) |
pick_firstARead-onlyInspect
Rejoin two branches: takes the outputs of several conditional steps and emits the first one that actually ran.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| values | No | the branches to choose between, in preference order. Wire one output from each arm. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| fallback | 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 computed. |
Output Schema
| Name | Required | Description |
|---|---|---|
| index | Yes | which branch it came from (0 = the first wired) |
| value | Yes | the first branch that produced anything |
| record | Yes | the same value when it is a record, so it can drive a downstream $subject |
| ranCount | Yes | how many branches produced anything. More than 1 means the conditions were not exclusive |
plan_master_mixARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| setup | 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-rr001a (TaKaRa Ex Taq (RR001A)), takara-la-taq-rr002a (TaKaRa LA Taq (RR002A)), takara-ex-premier-rr370a (TaKaRa Ex Premier (RR370A)), primestar-gxl-r050a (PrimeSTAR GXL (R050A), standard protocol), primestar-gxl-r050a-rapid (PrimeSTAR GXL (R050A), rapid protocol), primestar-hs-r010a (PrimeSTAR HS (R010A)), primestar-max-r045a (PrimeSTAR Max (R045A)), primestar-longseq-r055a (PrimeSTAR LongSeq (R055S/R055A)), cloneamp-hifi-639298 (CloneAmp HiFi PCR Premix (639298)), speedstar-hs-rr070a (SpeedSTAR HS (RR070A)), terra-direct-639270 (Terra PCR Direct Polymerase Mix (639270)), titanium-taq-639208 (Titanium Taq DNA Polymerase (639208)), advantage-hd-639241 (Advantage HD Polymerase Mix (639241)), qiagen-taq-201203 (QIAGEN Taq DNA Polymerase (201203)), qiagen-hotstartaq-203203 (QIAGEN HotStarTaq DNA Polymerase (203203)). Only applies when components is not given. | neb-phusion-m0530 |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| overage | No | extra mix for pipetting loss, as a percent of the N-reaction volume. In %. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| mg_final | 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 HotStarTaq DNA Polymerase (203203). In mM. Only applies when setup is qiagen-taq-201203 or qiagen-hotstartaq-203203. | |
| reactions | No | how many reactions the mix is for. | |
| components | 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) }. Advanced. | |
| include_dmso | 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. | |
| primer_final | 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. Only applies when setup is takara-taq-r001a or takara-ex-taq-rr001a or takara-la-taq-rr002a or takara-ex-premier-rr370a or primestar-gxl-r050a or primestar-gxl-r050a-rapid or primestar-hs-r010a or primestar-max-r045a or primestar-longseq-r055a or cloneamp-hifi-639298 or speedstar-hs-rr070a or terra-direct-639270 or advantage-hd-639241 or qiagen-taq-201203 or qiagen-hotstartaq-203203. | |
| primer_stock | 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-taq-rr002a or takara-ex-premier-rr370a or primestar-gxl-r050a or primestar-gxl-r050a-rapid or primestar-hs-r010a or primestar-max-r045a or primestar-longseq-r055a or cloneamp-hifi-639298 or speedstar-hs-rr070a or terra-direct-639270 or advantage-hd-639241 or qiagen-taq-201203 or qiagen-hotstartaq-203203. | |
| reaction_volume | 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 | 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 not given. | |
| include_q_solution | 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. Only applies when setup is qiagen-taq-201203 or qiagen-hotstartaq-203203. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | each component: name, µl per reaction, µl in the mix (null when added per tube) |
| mixTotal | Yes | µl of master mix to prepare |
| multiplier | Yes | reactions × (1 + overage/100) |
| dispensePerTube | Yes | µl of master mix to dispense into each tube |
plan_next_toolsARead-onlyInspect
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 its DECLARED data files the run in hand already read, so a step that would re-read the same table can be told apart.
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | the tool whose run just finished — its declared outputs are what is in hand. Leave unset and give `output_types` instead. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| max_steps | No | longest chain to consider when a `target_type` is given. | |
| read_only | No | keep only steps that write nothing. | |
| target_type | No | optional: the output type you want to reach. Returns the shortest chains of tools that get there. | |
| output_types | No | the port types in hand, when no single tool produced them (`sequence`, `record`, `bands`, `sites`, `protocol`, `matrix`, `series`). |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many tools can consume these outputs by their declared types |
| paths | Yes | the shortest chains of tools reaching `target_type`, when one was asked for |
| tools | Yes | the candidates, in catalog order: the parameter each wire lands on, the question that tool answers, its limits, what grades it, and what it reads |
| message | Yes | what was walked, in words |
| outputs | Yes | the types the walk started from |
| untyped | Yes | tools declaring an untyped parameter the builder would let this be wired into — a wire the graph cannot vouch for |
plan_rnaseq_experimentBRead-onlyInspect
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 across genes whose effects differ, with the FDR controlled (ssizeRNA 1.3.3, Bi & Liu 2016).
| Name | Required | Description | Default |
|---|---|---|---|
| m | No | genes tested. Only applies when method is exact. | |
| n | No | biological replicates in the control group, when solving power. Only applies when solve_for is power. | |
| m1 | No | genes expected to be differentially expressed. Only applies when method is exact. | |
| fdr | No | the false discovery rate to control across the experiment. | |
| pi0 | 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. | |
| count | No | λ₀, the average read count for a prognostic gene in the control group. Only applies when method is exact. | |
| max_n | No | the largest replicate count to search. Only applies when method is average_power. Advanced. | |
| power | No | the power to reach, when solving n. | |
| sigma | No | the common within-gene standard deviation on that scale. Only applies when method is average_power. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| counts | 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. | |
| method | 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 is drawn from a normal. Values: exact (Exact negative-binomial test), average_power (Average power across genes). | exact |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| effect_sd | No | the spread of those true effects ACROSS genes; 0 would make every gene identical. Only applies when method is average_power. | |
| solve_for | No | size the experiment, or score a design you already have. Values: n (Replicates per group), power (Power). | n |
| dispersion | 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 | No | k, the ratio of treatment to control group size. Only applies when method is exact. Advanced. | |
| dispersions | No | the dispersion of each gene in `counts`, in the same order. Only applies when method is exact. | |
| effect_mean | No | the mean of the normal each gene's true log-fold-change is drawn from. Only applies when method is average_power. | |
| fold_change | No | ρ, the minimum fold change to detect in a prognostic gene. Only applies when method is exact. | |
| normalization_ratio | No | w, the ratio of the two groups' normalization factors. Only applies when method is exact. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| n | Yes | replicates per group (the control group, when the groups differ) |
| rows | Yes | each (n, power) the search evaluated, one row per n in n order, or every (pi0, n, power) for average power |
| alpha | Yes | the per-gene α the FDR target implies |
| curve | Yes | power against replicates, which is the plot this question is read from |
| power | Yes | the power that number of replicates gives |
| rCall | Yes | the R call that reproduces the answer |
| method | Yes | which of the two questions was answered |
| solved | Yes | which quantity was solved |
| perGene | Yes | the power of each gene in `counts`, when a pilot distribution was given |
plan_serial_dilutionBRead-onlyInspect
Plan a serial dilution: the same fold dilution repeated tube after tube from a stock, each tube made to one volume.
| Name | Required | Description | Default |
|---|---|---|---|
| fold | No | the dilution at each step, as a fold (1:10 is 10). | |
| steps | No | how many dilutions to make. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| tube_volume | Yes | the volume of each dilution after mixing (transfer plus diluent). | |
| tube_volume_unit | No | the unit of the tube volume. | µL |
| stock_concentration | Yes | concentration of the stock the series starts from. | |
| stock_concentration_unit | No | the unit of the stock concentration, which every tube is reported in. | mM |
Output Schema
| Name | Required | Description |
|---|---|---|
| final | Yes | the last tube's concentration, in the stock's unit |
| tubes | Yes | each tube: step, concentration, cumulative fold, volume left after its transfer |
| diluent | Yes | diluent in each tube, in the tube volume's unit |
| transfer | Yes | volume moved into each tube, in the tube volume's unit |
plan_thermocycler_programARead-onlyInspect
Plan the cycling programme for an amplicon on a NAMED enzyme, and check the reaction against that manufacturer's own published limits.
| Name | Required | Description | Default |
|---|---|---|---|
| steps | 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. | auto |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| cycles | No | cycles in the main block. | |
| enzyme | 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 (no datasheet)), takara-taq (Takara Bio · TaKaRa Taq / EmeraldAmp GT), takara-ex-taq (Takara Bio · TaKaRa Ex Taq / EmeraldAmp MAX), takara-la-taq (Takara Bio · TaKaRa LA Taq), takara-ex-premier (Takara Bio · TaKaRa Ex Premier), primestar-gxl (Takara Bio · PrimeSTAR GXL DNA Polymerase), primestar-hs (Takara Bio · PrimeSTAR HS DNA Polymerase), primestar-max (Takara Bio · PrimeSTAR Max DNA Polymerase Ver.2), primestar-longseq (Takara Bio · PrimeSTAR LongSeq DNA Polymerase), cloneamp-hifi (Takara Bio · CloneAmp HiFi PCR Premix), speedstar-hs (Takara Bio · SpeedSTAR HS DNA Polymerase), terra-direct (Takara Bio · Terra PCR Direct Polymerase Mix), titanium-taq (Takara Bio · Titanium Taq DNA Polymerase), advantage-hd (Takara Bio · Advantage HD Polymerase Mix), qiagen-taq (QIAGEN · Taq DNA Polymerase), qiagen-hotstartaq (QIAGEN · HotStarTaq DNA Polymerase). | generic |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| anneal_c | Yes | annealing temperature [°C] for the pair — the Ta the Tm model gave you, not a guess this tool makes. In °C. | |
| touchdown | 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). | |
| gc_percent | Yes | product GC [%], which decides whether the vendor's GC window is cleared. In %. | |
| polymerase | No | which annealing convention and which preset supplies whatever the datasheet does not. Values: taq (Taq), dbd (Phusion / Q5 (DNA-binding domain)). | taq |
| amplicon_bp | Yes | product length [bp] — pcr_amplify and design_primers both emit it. | |
| touchdown_cycles | No | touchdown cycles before the main block (they add to `totalCycles`). Only applies when touchdown is true. | |
| touchdown_delta_c | No | how far the annealing temperature drops per touchdown cycle. In °C. Only applies when touchdown is true. |
Output Schema
| Name | Required | Description |
|---|---|---|
| program | Yes | the planned programme as a thermocycler would take it, stage by stage |
| findings | Yes | the reaction check: each finding with its severity, its sentence and the vendor line it quotes. Empty for a reaction inside every published limit, and absent entirely for `generic`, which has no limits to check. |
| denatureC | Yes | per-cycle denaturation temperature [°C] actually planned |
| denatureSec | Yes | per-cycle denaturation time [s] actually planned |
| totalCycles | Yes | cycles including any touchdown block |
| extensionSec | Yes | extension time [s] this amplicon needs at the enzyme's published rate |
| fromDatasheet | Yes | which of the planned numbers came from the product (the rest are the preset’s) — the same list the panel turns into its sentence |
population_ancestryBRead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| kTo | No | largest number of ancestral populations to fit; every K from kFrom up is fitted, on one random stream. | |
| vcf | Yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. | |
| seed | 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. | |
| alpha | No | regularisation added to every cell of FᵀF in the Q step: larger values push each sample toward fewer ancestries. Advanced. | |
| kFrom | No | smallest number of ancestral populations to fit. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| ploidy | No | 2 for diploid ALT counts 0/1/2, 1 for haploid 0/1. Advanced. | |
| groupBy | No | which column of the sample table groups the samples; empty is its first grouping column. | |
| holdOut | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| tolerance | No | stop when the relative change in the least-squares criterion falls below this (after 16 passes). Advanced. | |
| iterations | No | most alternating passes per K. Advanced. | |
| populations | 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. | |
| holdOutShare | No | share of genotypes held out for the cross-entropy. Only applies when holdOut is true. |
Output Schema
| Name | Required | Description |
|---|---|---|
| runs | Yes | one row per K: K, the masked cross-entropy (null without holding out), and the passes the fit took |
| bestK | Yes | the K with the lowest cross-entropy, or the largest fitted K when nothing was held out |
| ancestry | Yes | one row per sample at the best K: sample, its group, and its share of each ancestral population |
| ancestralGenotypeFrequencies | Yes | one row per site at the best K: chrom, pos, ref, alt, and each ancestral population's frequency of each genotype (0, 1, 2 ALT copies) |
population_fstARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| vcf | Yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| compare | No | the populations to compare, comma-separated; empty is every group of the column. | |
| groupBy | No | which column of the sample table groups the samples; empty is its first grouping column. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| estimator | 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: weirCockerham (Weir–Cockerham θ), hudson (Hudson Fst), patterson (Patterson Fst). | hudson |
| blockLength | No | sites per jackknife block for the average's standard error; a trailing partial block is dropped, as scikit-allel does. | |
| populations | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| sites | Yes | per site: pos, and per comparison the site's Fst (numerator / denominator), null where undefined |
| matrix | Yes | pairwise average Fst between every compared population (Hudson and Patterson) |
| average | Yes | per comparison: the populations, Fst over all sites, its jackknife standard error, blocks |
population_site_statsARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| vcf | Yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. | |
| group | No | compute over this group's samples only; empty is every sample. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| groupBy | No | which column of the sample table groups the samples; empty is its first grouping column. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| populations | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| sites | Yes | one row per record: chrom, pos, ref, alts, allele counts and frequencies, AN, called, missing, het, homRef, homAlt, ho, he, f, hwe and excHet per ALT |
| samples | Yes | one row per sample: its group, called, missing, het, homAlt and the missing and het rates |
| summary | Yes | sites, samples, segregating, biallelic and multiallelic sites, mean Ho and He, and the sites with the smallest HWE p-values |
primer_checkARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| primer | Yes | primer sequence 5'→3'. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| thresholds | 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 used comes back in `thresholds`, because a verdict whose cutoff is not stated cannot be checked. Move it to say what you are asking: screening a pool tolerates a lower `strong` than checking a clone does. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| sites | Yes | annealing sites with identity %, mismatches, strand, the 3'-anchored footprint, and each one's tier and what that tier MEANS — read the tier rather than re-deriving it from the percentage, because the bar is a parameter |
| bestTier | Yes | the best site's tier: exact · strong · weak · marginal · none, or unknown when nothing was graded |
| siteCount | Yes | how many sites the seed found at all. Branch on this rather than on the length of `sites`: 0 is a real result and means the oligo's 3' end matches nowhere, not that it binds weakly |
| thresholds | Yes | the four boundaries every verdict above was made against, and whether they came from your panel or from the upstream default — the same shape the `thresholds` parameter takes, so a run can be repeated at the bar it was graded at |
| bindingCount | Yes | how many sites are at or above the `strong` boundary — the ones expected to bind. More than one is a different experiment from one: a primer with two real sites gives two products, so a single clean band is not what this predicts |
| bestIdentityPct | Yes | identity of the best site, or 0 when nothing was found — a measurement, never a verdict |
propagate_uncertaintyARead-onlyInspect
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 side, because they disagree in informative ways: the Taylor arm is exact only for a linear expression, and a ratio is not linear.
| Name | Required | Description | Default |
|---|---|---|---|
| nsim | No | Monte-Carlo draws. Only applies when do_sim is true. | |
| seed | No | R's `set.seed` value, so a simulated or permuted run is reproducible and citable. Advanced. | |
| ties | 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 readings of the same tube. Only applies when do_perm is true. | |
| input | 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 the permutation arm can resample, because permutation resamples observed ROWS and a mean with an SD beside it has none. | stat |
| nperm | No | permutations. Only applies when do_perm is true. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| do_sim | 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. | |
| do_perm | 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 is raw. | |
| use_cov | 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 the error of their ratio. Only applies when input is raw. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| dist_sim | 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 when do_sim is true. | norm |
| variables | 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 dropped pairwise, never read as zero). Tab- or comma-separated. | |
| conf_level | No | the level the reported bounds are read at. | |
| expression | 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`. | |
| second_order | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| gradient | Yes | the printed partial derivative per variable, and its value at the means |
| permuted | Yes | the permutation arm, same fields. Null in `stat` mode, which has no rows to resample |
| confLower | Yes | lower analytic bound at `conf_level` |
| confUpper | Yes | upper analytic bound |
| simulated | Yes | the Monte-Carlo arm: mean, sd, median, mad and its own interval. Every field null when it was not run — a nonlinear expression whose two arms disagree is the finding, not a display detail |
| variables | Yes | the variable names the run used, in expression order — every other array here is in this order |
| permPValues | Yes | permutation p-values for the three hypotheses upstream tests, in `perm > init` / `perm == init` / `perm < init` order |
| propagatedSd | Yes | the analytic (Taylor) standard error — the number to report when the expression is close to linear |
| contributions | Yes | how much of the propagated variance each variable contributes, in %, first-order — which measurement to make more precisely |
| firstOrderMean | Yes | the expression evaluated at the input means, before the second-order correction |
| propagatedMean | Yes | the expression evaluated at the input means, with the second-order correction when it is on |
| secondOrderMean | Yes | the mean with the second-order Taylor correction applied, whether or not the reported mean uses it |
protein_digestARead-onlyInspect
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) or sequentially (one result per enzyme).
| Name | Required | Description | Default |
|---|---|---|---|
| mode | 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 intact protein. | concurrent |
| semi | No | also emit semi-enzymatic peptides (one ragged terminus). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzyme | No | 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-skatole (BNPS-Skatole), bromelain (Bromelain), caspase-1 (Caspase 1), caspase-10 (Caspase 10), caspase-2 (Caspase 2), caspase-3 (Caspase 3), caspase-4 (Caspase 4), caspase-5 (Caspase 5), caspase-6 (Caspase 6), caspase-7 (Caspase 7), caspase-8 (Caspase 8), caspase-9 (Caspase 9), chymotrypsin-high (Chymotrypsin (high specificity)), chymotrypsin-low (Chymotrypsin (low specificity)), clostripain (Clostripain (Arg-C)), cnbr (CNBr), elastase (Elastase), enterokinase (Enterokinase), factor-xa (Factor Xa), ficin (Ficin), formic-acid (Formic acid), glu-c (Glu-C (D and E)), glutamyl-endopeptidase (Glutamyl endopeptidase), granzyme-b (Granzyme B), hydroxylamine (Hydroxylamine), iodosobenzoic-acid (Iodosobenzoic acid), lysc (Lys-C), lysn (Lys-N), lysarginase (LysargiNase), neutrophil-elastase (Neutrophil elastase), ntcb (NTCB (2-nitro-5-thiocyanobenzoic acid)), papain (Papain), pepsin-ph2.0 (Pepsin (pH > 2)), pepsin-ph1.3 (Pepsin (pH 1.3)), proalanase (ProAlanase), proline-endopeptidase (Proline endopeptidase), proteinase-k (Proteinase K), staph-peptidase-i (Staphylococcal peptidase I), tev (TEV protease (Tobacco Etch Virus)), thermolysin (Thermolysin), thrombin (Thrombin), thrombin-sg (Thrombin (sequencing grade)), trypsin (Trypsin), trypsin-low (Trypsin (low specificity)), trypsin-simple (Trypsin (simple K/R)), alp (α-lytic protease (aLP)), custom (Custom cleavage rule). | trypsin |
| charges | No | charge states to report m/z for, e.g. [1,2,3] — [M+zH]z+ from the monoisotopic mass. | |
| enzymes | 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. | |
| massMax | No | keep only peptides at or below this monoisotopic mass [Da]; omit for no upper bound. | |
| massMin | No | keep only peptides at or above this monoisotopic mass [Da]; omit for no lower bound. | |
| protein | Yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cysteine | No | cysteine alkylation applied before the digest, as ExPASy PeptideMass offers it. Mass deltas are Unimod's. | none |
| maxLength | No | drop peptides longer than this (residues). | |
| minLength | No | drop peptides shorter than this (residues). | |
| customRegex | 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 mutually exclusive with `customCleave`. Advanced. | |
| customCleave | 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. | |
| metOxidation | No | methionine oxidation. 'all' oxidises every Met (masses move, peptide list unchanged); 'both' lists each Met peptide TWICE, unmodified and oxidised, as PeptideMass does. | off |
| keilExceptions | 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; pyteomics does not, so turn it off to cross-check against pyteomics. | |
| missedCleavages | 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). | |
| customExceptions | No | exceptions for the 'custom' enzyme; each must repeat the rule it blocks, e.g. '(K or R,)(P)' = not when P follows. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | peptides returned after any mass filter |
| sites | Yes | cleavage-site positions (0-based residue index the next peptide starts at) |
| results | Yes | multi-enzyme only: one entry per digestion (per enzyme in sequential mode, one for the whole set in concurrent), each with its own peptides, sites and coverage |
| coverage | Yes | fraction of the protein covered by the peptides returned |
| peptides | Yes | peptides with start/end, sequence, missed cleavages, masses and m/z (all results pooled in multi-enzyme mode) |
| totalPeptides | Yes | peptides the digest produced BEFORE the mass filter |
protein_disorderBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| pH | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| pKaSet | 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)), Sillero (Sillero (Sillero 1989)), Rodwell (Rodwell (Rodwell 1982)), Lehninger (Lehninger (Nelson 2017)), Toseland (Toseland (Toseland 2006)), Thurlkill (Thurlkill (Thurlkill 2006)), Nozaki (Nozaki (Nozaki 1971)), Dawson (Dawson (Dawson 1989)), Bjellqvist (Bjellqvist (Bjellqvist 1994)), ProMoST (ProMoST (Halligan 2004)), IPC_protein (IPC_protein (Kozlowski 2016)), IPC_peptide (IPC_peptide (Kozlowski 2016)), Vollhardt (Vollhardt (Vollhardt 2014)). | IPC_protein |
| window | 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. | |
| protein | Yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| chargeModel | 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. | net |
| countHistidine | 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 some FoldIndex descendants do count it. |
Output Schema
| Name | Required | Description |
|---|---|---|
| plot | Yes | the FoldIndex profile as a plot; below zero is predicted disordered |
| scores | Yes | just the I_F value per window, parallel to `positions` |
| window | Yes | the window actually used |
| overall | Yes | whole-protein FoldIndex from the global means — the number the 2005 paper's abstract reports. Below zero = predicted unfolded |
| windows | Yes | every window: { position, centerResidue, hydropathy, charge, score } — the series a plot draws |
| boundary | Yes | the Uversky 2000 boundary |⟨R⟩| = 2.785·⟨H⟩ − 1.151 evaluated at this protein's ⟨H⟩ — what `meanNetCharge` is above or below |
| segments | Yes | runs of consecutive negative windows as 1-based inclusive residue spans, with each run's mean and minimum I_F |
| unfolded | Yes | whether the whole-protein point sits above that boundary, i.e. predicted natively unfolded |
| positions | Yes | 1-based centre residue of each window, parallel to `scores` |
| pKaSetName | Yes | the pKa set actually used, or '' for the 'net' model which needs none |
| chargeModel | Yes | the charge model actually used |
| windowCount | Yes | how many windows were scored — the series length, so a fraction can be read back |
| meanNetCharge | Yes | |⟨R⟩| over the whole chain — the y of the Uversky point |
| meanHydropathy | Yes | ⟨H⟩ over the whole chain — the x of the Uversky charge-hydropathy point |
| disorderedWindows | Yes | how many windows score below zero |
| disorderedFraction | Yes | that count as a fraction of all windows |
protein_disorder_metapredictBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| convert | 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. | |
| protein | Yes | the protein sequence; wire it from translate_sequence. | |
| version | 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)). | V3 |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| threshold | 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. | |
| gapClosure | No | the longest run of sub-threshold residues closed when flanked by disordered runs of the same length. Default 10. Advanced. | |
| minimumIdrSize | No | the shortest IDR the domain caller reports, in residues; also sets the smoothing window (twice this, made odd). Default 12. Advanced. | |
| minimumFoldedDomain | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| idrs | Yes | intrinsically disordered regions as 1-based inclusive spans with their length and mean score |
| scores | Yes | the per-residue disorder score, 0–1, residue 1 first |
| version | Yes | the network actually used |
| converted | Yes | how many B/U/X/Z residues were read as N/C/G/Q |
| threshold | Yes | the threshold actually used |
| idrResidues | Yes | how many residues the IDRs cover |
| foldedDomains | Yes | the complementary folded domains, same shape |
| percentDisordered | Yes | percentage of residues scoring at or above the threshold, to 3 dp |
| disorderedResidues | Yes | how many residues score at or above the threshold |
protein_membrane_profileARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| angle | No | rotational angle per residue in degrees: 100 for an alpha-helix (default), 160 for a beta-sheet. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| window | No | sliding window in residues (default 11). | |
| protein | Yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| minWindows | No | shortest run of same-class windows reported as a segment (default 2; a one-window run is usually noise). |
Output Schema
| Name | Required | Description |
|---|---|---|
| plot | Yes | the Eisenberg profile as a plot: moment and mean hydrophobicity per window |
| moment | Yes | hydrophobic moment uH per window |
| position | Yes | per-window class: G globular, T transmembrane, S surface-seeking |
| segments | Yes | runs of one class as 1-based inclusive residue spans, with their mean/peak moment |
| transmembrane | Yes | how many segments are classified transmembrane |
| hydrophobicity | Yes | mean Eisenberg hydrophobicity H per window |
protein_profileARead-onlyInspect
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 transfer).
| Name | Required | Description | Default |
|---|---|---|---|
| edge | No | ProtScale relative weight of the window's edge residues, 0-1 (default 1 = unweighted). | |
| kind | No | which profile to compute. Ignore this and pass `scaleId` to reach the full ProtScale catalogue. | hydropathy |
| scale | 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 & Mould (1991)), BullBreese (Bull & Breese (1974)), Casari (Casari & Sippl, hydrophobic potential (JMB 224:725)), Cid (Cid (Protein Eng 5:373)), Cowan3.4 (Cowan at pH 3.4 (1990)), Cowan7.5 (Cowan at pH 7.5 (1990)), Eisenberg (Eisenberg, normalized consensus (1984)), Engelman (Engelman, transfer free energy (Annu Rev Biophys 15:321)), Fasman (Fasman (1989)), Fauchere (Fauchere (1983)), GoldSack (Goldsack & Chalifoux, free energy of mixing (J Theor Biol 39:645)), Guy (Guy, transfer free energy kcal/mol (1985)), Jones (Jones (J Theor Biol 50:167)), Juretic (Juretic (Theor Comput Chem 5:405)), Kidera (Kidera factors (J Protein Chem 4:23)), Miyazawa (Miyazawa, contact energy from 3D structures (1985)), Parker (Parker, HYDROPHILICITY from HPLC retention (1986)), Ponnuswamy (Ponnuswamy, folded-protein character (Prog Biophys Mol Biol 59:57)), Rose (Rose (1985)), Roseman (Roseman (1988)), Sweet (Sweet, optimized matching OMH (1983)), Tanford (Tanford (1962)), Wilson (Wilson, hydrophobic constants from HPLC retention (1981)), Zimmerman (Zimmerman (J Theor Biol 21:170)). Only applies when kind is hydropathy. | KyteDoolitle |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| window | 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 interior. | |
| protein | Yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. | |
| scaleId | 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 refused by name rather than one silently winning. The panel opens on `scaleId: hydropath-doolittle`, which computes the same curve as the `kind`/`scale` defaults. Values: molecularweight (Molecular weight), numbercodons (Number of codon(s)), bulkiness (Bulkiness), polarityzimmerman (Polarity / Zimmerman), polaritygrantham (Polarity / Grantham), refractivity (Refractivity), recognitionfactors (Recognition factors), hphob-eisenberg (Hphob. / Eisenberg et al.), hphob-sweet (Hphob. OMH / Sweet et al.), hphob-woods (Hphob. / Hopp & Woods), hydropath-doolittle (Hydropath. / Kyte & Doolittle), hphob-manavalan (Hphob. / Manavalan et al.), hphob-leo (Hphob. / Abraham & Leo), hphob-black (Hphob. / Black), hphob-breese (Hphob. / Bull & Breese), hphob-fauchere (Hphob. / Fauchere et al.), hphob-guy (Hphob. / Guy), hphob-janin (Hphob. / Janin), hphob-miyazawa (Hphob. / Miyazawa et al.), hphob-argos (Hphob. / Rao & Argos), hphob-roseman (Hphob. / Roseman), hphob-tanford (Hphob. / Tanford), hphob-wolfenden (Hphob. / Wolfenden et al.), hphob-welling (Hphob. / Welling & al), hphob-wilson (Hphob. HPLC / Wilson & al), hphob-parker (Hphob. HPLC / Parker & al), hphob-ph3-4 (Hphob. HPLC pH3.4 / Cowan), hphob-ph7-5 (Hphob. HPLC pH7.5 / Cowan), hphob-mobility (Hphob. / Rf mobility), hplchfba (HPLC / HFBA retention), hplctfa (HPLC / TFA retention), transmembranetendency (Transmembrane tendency), hplc2-1 (HPLC / retention pH 2.1), hplc7-4 (HPLC / retention pH 7.4), buriedresidues (% buried residues), accessibleresidues (% accessible residues), hphob-chothia (Hphob. / Chothia), hphob-rose (Hphob. / Rose & al), ratioside (Ratio hetero end/side), averageburied (Average area buried), averageflexibility (Average flexibility), alpha-helixfasman (alpha-helix / Chou & Fasman), beta-sheetfasman (beta-sheet / Chou & Fasman), beta-turnfasman (beta-turn / Chou & Fasman), alpha-helixroux (alpha-helix / Deleage & Roux), beta-sheetroux (beta-sheet / Deleage & Roux), beta-turnroux (beta-turn / Deleage & Roux), coilroux (Coil / Deleage & Roux), alpha-helixlevitt (alpha-helix / Levitt), beta-sheetlevitt (beta-sheet / Levitt), beta-turnlevitt (beta-turn / Levitt), totalbeta-strand (Total beta-strand), antiparallelbeta-strand (Antiparallel beta-strand), parallelbeta-strand (Parallel beta-strand), a-a-composition (A.A. composition), a-a-swiss-prot (A.A. comp. in Swiss-Prot), relativemutability (Relative mutability), biopython-argos (Argos), biopython-casari (Casari & Sippl), biopython-cid (Cid et al.), biopython-engelman (Engelman (GES)), biopython-fasman (Fasman), biopython-goldsack (Gold Sack & Chalifoux), biopython-jones (Jones), biopython-juretic (Juretic et al.), biopython-kidera (Kidera et al.), biopython-ponnuswamy (Ponnuswamy), biopython-zimmerman (Zimmerman (hydrophobicity)), biopython-flex (Flexibility (Vihinen)), biopython-surface-accessibility (Surface accessibility (Emini)), biopython-janin (Janin (Biopython rounding)). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| normalize | 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`. | |
| weightVariation | 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. | linear |
Output Schema
| Name | Required | Description |
|---|---|---|
| peak | Yes | index into `values` of the LARGEST value. Large is not a synonym for hydrophobic: on a transfer free energy or a hydrophilicity scale the largest window is the most hydrophilic one, and on a flexibility or accessibility profile it is neither. `label` names the scale; `protein_properties.gravyHydrophobicEnd` answers the direction for the 28 hydropathy tables |
| plot | Yes | the profile as a plot along the chain |
| label | Yes | the profile's cited name, e.g. 'Hydropathy (KyteDoolitle)' |
| trough | Yes | index into `values` of the SMALLEST value — the other extreme, which is the hydrophobic one on an inverted scale |
| values | Yes | one profile value per window |
| window | Yes | window actually used (flexibility forces 9) |
| centres | Yes | 0-based residue index each window centres on, parallel to `values` |
| reference | Yes | the scale's primary citation, when it came from the ProtScale catalogue. Empty for the five ProtParam kinds |
| normalized | Yes | whether the scale was rescaled to 0-1 before windowing. False for the five ProtParam kinds, which are never rescaled |
| peakResidue | Yes | 1-based residue the peak window centres on |
| troughResidue | Yes | 1-based residue the trough window centres on |
| weightVariation | Yes | the ProtScale weight model the values were computed under, 'linear' or 'exponential' ('linear' for the five ProtParam kinds) |
protein_propertiesBRead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| pH | No | pH the net charge is reported at (default 7.0). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| protein | Yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| gravyScale | 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)), AbrahamLeo (Abraham & Leo (1987)), Argos (Argos (Eur J Biochem 128:565)), BlackMould (Black & Mould (1991)), BullBreese (Bull & Breese (1974)), Casari (Casari & Sippl, hydrophobic potential (JMB 224:725)), Cid (Cid (Protein Eng 5:373)), Cowan3.4 (Cowan at pH 3.4 (1990)), Cowan7.5 (Cowan at pH 7.5 (1990)), Eisenberg (Eisenberg, normalized consensus (1984)), Engelman (Engelman, transfer free energy (Annu Rev Biophys 15:321)), Fasman (Fasman (1989)), Fauchere (Fauchere (1983)), GoldSack (Goldsack & Chalifoux, free energy of mixing (J Theor Biol 39:645)), Guy (Guy, transfer free energy kcal/mol (1985)), Jones (Jones (J Theor Biol 50:167)), Juretic (Juretic (Theor Comput Chem 5:405)), Kidera (Kidera factors (J Protein Chem 4:23)), Miyazawa (Miyazawa, contact energy from 3D structures (1985)), Parker (Parker, HYDROPHILICITY from HPLC retention (1986)), Ponnuswamy (Ponnuswamy, folded-protein character (Prog Biophys Mol Biol 59:57)), Rose (Rose (1985)), Roseman (Roseman (1988)), Sweet (Sweet, optimized matching OMH (1983)), Tanford (Tanford (1962)), Wilson (Wilson, hydrophobic constants from HPLC retention (1981)), Zimmerman (Zimmerman (J Theor Biol 21:170)). | KyteDoolitle |
| momentWindow | No | sliding window for the hydrophobic moment, in residues (default 11; clamped to the sequence length). | |
| cystineConvention | 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. | cystine |
Output Schema
| Name | Required | Description |
|---|---|---|
| mw | Yes | molecular weight [Da] — a FLOOR when `nonStandard` is non-empty, because ProtParam has no mass for those letters and still counts them in the length |
| pI | Yes | isoelectric point |
| a280 | Yes | A280 of a 1 g/L solution (cystines form) — divide a spectrophotometer reading by this |
| turn | Yes | fraction of residues favouring a turn |
| atoms | Yes | total number of atoms in the molecule, or null when a residue has no formula |
| boman | Yes | Boman potential protein-interaction index [kcal/mol] (>2.48 = protein-binding) |
| gravy | Yes | grand average of hydropathicity over `gravyScale`, or null when a residue has no value on it |
| helix | Yes | fraction of residues favouring an alpha-helix |
| sheet | Yes | fraction of residues favouring a beta-sheet |
| charge | Yes | net charge at `pH` |
| length | Yes | residues analysed, including any the mass tables have no row for |
| stable | Yes | ProtParam's own reading of the index: at or below 40. Null exactly when `instability` is — there is no verdict without a value |
| formula | Yes | molecular formula, ProtParam style (e.g. C1755H2634N466O557S5); empty when a residue has no formula |
| elements | Yes | atom counts per element (C, H, N, O, S) behind the formula, or null when a residue has no formula |
| aliphatic | Yes | aliphatic index (Ikai 1980) — higher suggests greater thermostability |
| nTerminal | Yes | the N-terminal residue the N-end rule half-lives below are read from |
| gravyScale | Yes | which hydropathy scale `gravy` was averaged over |
| aromaticity | Yes | aromaticity (Lobry 1994): the F+W+Y frequency, as a fraction |
| composition | Yes | residue counts, one entry per standard amino acid (ProtParam's composition table) |
| instability | Yes | instability index (>40 = unstable in vivo), or null when a residue the Guruprasad table has no row for makes it undefined — refused rather than computed on a spliced sequence |
| momentHelix | Yes | max Eisenberg hydrophobic moment at the α-helix periodicity (100°) |
| momentSheet | Yes | max Eisenberg hydrophobic moment at the β-sheet periodicity (160°) |
| nonStandard | Yes | residues with no mass at all (X, B, Z, gaps, *), with their positions: excluded from `mw`, `monoisotopicMw`, `formula` and `elements`, still counted in `length`. Empty on a clean chain |
| momentWindow | Yes | the window the two moments were measured over, after the clamp to the sequence length — a short peptide is not measured over 11 residues it does not have |
| halfLifeEcoli | Yes | estimated in-vivo half-life, E. coli (N-end rule) |
| halfLifeYeast | Yes | estimated in-vivo half-life, yeast (N-end rule) |
| monoisotopicMw | Yes | monoisotopic molecular weight [Da] — what mass spectrometry reports. Null when a residue has no mass, rather than a mass for a different molecule |
| scaleNonStandard | Yes | residues that ARE weighed but have no per-residue scale value (U, O). They are why `gravy` and `instability` can come back null on a sequence whose mass is exact |
| extinctionReduced | Yes | molar extinction coefficient at 280 nm [M-1 cm-1], all cysteines reduced |
| halfLifeMammalian | Yes | estimated in-vivo half-life, mammalian reticulocytes (N-end rule); '—' when the N-terminus has no entry |
| compositionPercent | Yes | the same table as mole percent of the chain |
| extinctionCystines | Yes | molar extinction coefficient at 280 nm [M-1 cm-1], cystines formed (per `cystineConvention`) |
| gravyHydrophobicEnd | Yes | which end of `gravyScale` is the hydrophobic one: 'higher' (Kyte & Doolittle and most others) or 'lower' (a transfer free energy or a hydrophilicity scale). Read `gravy` against this, never against zero alone |
| gravyZeroIsMeaningful | Yes | whether `gravyScale` takes both signs. False on the eight one-sided tables (Rose, Miyazawa, Argos, …), where the sign of `gravy` is a property of the scale and says nothing about this protein |
protein_signal_peptideBRead-onlyInspect
Signal-peptidase cleavage sites in a protein, by von Heijne's (1986) weight matrix as implemented by EMBOSS sigcleave.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| kingdom | 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 same sequence. | eukaryote |
| protein | Yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| minWeight | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| score | Yes | the best site's score — a sum of 15 log-odds, NOT a probability |
| sites | Yes | every site above the threshold, best first: { cleavageAfter, score, start, end, window, maturePeptide } |
| matrix | Yes | which training set was used, and how many peptides it was built from |
| scores | Yes | the score at every position, thresholded or not — the series a plot draws |
| siteCount | Yes | how many sites cleared the threshold |
| cleavageAfter | Yes | 1-based residue the best site cuts after; the mature chain starts at the next one. 0 when nothing cleared the threshold |
| maturePeptide | Yes | the predicted mature chain, from the cleavage site to the end |
| signalPeptide | Yes | residues 1..cleavageAfter, the predicted signal peptide |
protein_topologyARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| protein | Yes | the protein sequence (unambiguous one-letter codes); wire it from translate_sequence. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| decoding | 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 rather than states and is a genuinely different algorithm — and much slower on a long chain. | viterbi |
Output Schema
| Name | Required | Description |
|---|---|---|
| path | Yes | one label per residue, in sequence order |
| helices | Yes | how many runs are transmembrane helices — 0 means no helix was predicted, which for a cytosolic protein is the right answer and not a failure |
| logProb | Yes | log probability of the decoded path, in nats |
| summary | Yes | the topology in words — how many helices and which side the N-terminus is on, or that none was predicted |
| decoding | Yes | which decoder produced this path |
| segments | Yes | runs of one label as 1-based inclusive residue spans |
| posterior | Yes | per-residue posterior probability of each label — the confidence behind the path |
quantify_base_editingARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| guide | 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. | |
| trim3 | No | last base of the read the background model may be fitted on, 1-based inclusive. Pair it with `trim5`. | |
| trim5 | 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 automatic rule runs: drop the first 20 bases, then drop every base whose total peak height is under a tenth of the mean of what is left. The window is an INPUT to the answer, not a view: it is what the noise is estimated from, so tightening it lowers the cut-off. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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_end | No | the other end of an explicit placement, 1-based inclusive. Pair it with `guide_start`. | |
| guide_start | 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 protospacer needs: the analysis tests the bases you point at rather than refusing the read. | |
| p_value_cutoff | 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. | |
| guide_is_reverse_complement | No | search for the guide's reverse complement. A C→T edit on the guide strand then reads as G→A in the result. |
Output Schema
| Name | Required | Description |
|---|---|---|
| calls | Yes | every significant call: { guidePosition, index, guideBase, base, percent, pValue }, biggest first |
| edited | Yes | whether ANY base of the guide carries a non-reference signal above this trace's own noise. Wire it into a gate |
| report | Yes | the whole run: every guide position with all four base percentages and p-values, the four fitted noise models and their cut-off lines. This is what makes a negative checkable — 'no editing' and 'the model could never have fired' look identical without it |
| topChange | Yes | the biggest call as `reference→edited`, e.g. `C→T`. Empty when there is none |
| guideStart | Yes | 1-based position in the read's own base calls where the guide was found — what a canvas needs to draw it |
| topPercent | Yes | its share of that position's total peak height, 0–100 |
| topPosition | Yes | the guide position (1-based) of the biggest call, or 0 when there is none |
quantify_dpcrBRead-onlyInspect
Digital PCR (dPCR) partition counts to absolute concentration, with no standard curve.
| Name | Required | Description | Default |
|---|---|---|---|
| wells | 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 needs no renaming. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| ci_method | 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-density)), cloglog (Complementary log-log), exact (Exact (Clopper–Pearson)), logit (Logit), lrt (Likelihood ratio), probit (Probit), prop.test (Score test inverted, continuity-corrected), profile (Profile likelihood), wilson (Wilson score). Advanced. | wilson |
| volume_cv | 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 consumes - the one figure this repo has a published source for is QuantStudio 3D chip (Majumdar 2017) at 3.03 %, and that paper says the vendor re-estimates it per chip rather than treating it as a platform constant. In %. Only applies when volume_model is normal or truncated. | |
| conf_level | No | confidence level for the interval. Advanced. | |
| ratio_target | 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 comparison. | |
| volume_model | 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 negative probability over a normal volume distribution and invert it: `normal` is the closed-form Eq (9), `truncated` the exact Eq (13) over a normal cut off at zero, which is the honest density because a partition cannot hold a negative volume. The spread biases the standard estimate DOWNWARD, hard at high occupancy and not at all at low. Values: poisson (Standard Poisson (no correction)), normal (Poisson-Plus, normal (Eq 9)), truncated (Poisson-Plus, truncated normal (Eq 13)). | poisson |
| dilution_factor | No | fold dilution applied to the sample before the reaction (2 = diluted 1:2). Advanced. | |
| ratio_reference | No | the assay it is measured against: the single-copy or known-ploidy reference, again by its Target name. | |
| merge_replicates | 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 concentrations. | |
| reference_copies | No | copies of the REFERENCE target per genome. 2 is a diploid autosome, 1 a haploid or single-copy locus. Advanced. | |
| reaction_volume_ul | No | total reaction volume, for copies per reaction. In uL. | |
| template_volume_ul | No | volume of template added to the reaction. Left at 0 the sample-concentration row is omitted rather than guessed. In uL. Advanced. | |
| partition_volume_nl | 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 reported with the result. In nL. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | one reading per well, or per pooled replicate group: occupancy, lambda with its interval, and every concentration the supplied volumes support |
| count | Yes | how many readings were produced |
| ratios | Yes | target-vs-reference copy number per sample, with the exact Poisson rate ratio and its interval rescaled onto the concentration scale the number is on. Empty when no assay pair was named — never a guessed pair |
| flagged | Yes | readings carrying at least one dMIQE occupancy flag |
| ciMethod | Yes | the interval method that produced the bounds: a CI without its method is not comparable |
| confLevel | Yes | the confidence level every interval in `rows` was computed at |
| volumeModel | Yes | how partition-volume spread was handled. `poisson` means it was not — a concentration without this is not comparable with one that was corrected |
| volumeCvPercent | Yes | the volume spread the correction used, echoed for the same reason as the partition volume: it changed the number |
| partitionVolumeNl | Yes | the partition volume the concentrations were computed at, echoed because dMIQE requires it to travel with the number |
query_databaseBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | cap on rows returned, where the authority honours one. | |
| query | 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`. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| authority | 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), crossref (Crossref — literature), arxiv (arXiv — literature), biorxiv (bioRxiv — literature), medrxiv (medRxiv — literature), datacite (DataCite — literature), ensembl (Ensembl REST — genomics), ucsc (UCSC Genome Browser API — genomics), biomart (Ensembl BioMart — genomics), mygene (MyGene.info — genomics), ncbi-gene (NCBI Gene (E-utilities) — genomics), hgnc (HGNC (genenames.org) — genomics), gnomad (gnomAD (Broad) — genomics), clinvar (NCBI ClinVar — genomics), dbsnp (NCBI dbSNP — genomics), variation (NCBI Variation Services — genomics), cadd (CADD (Kircher lab) — genomics), gtex (GTEx Portal — genomics), eqtlcatalogue (eQTL Catalogue (EBI) — genomics), gwascatalog (GWAS Catalog (EBI/NHGRI) — genomics), pheweb (PheWeb / FinnGen — genomics), uniprot (UniProt — proteins), interpro (InterPro / Pfam (EBI) — proteins), string (STRING — proteins), proteinatlas (Human Protein Atlas — proteins), alphafold (AlphaFold DB (EBI) — proteins), pdb (RCSB PDB — proteins), emdb (EMDB (EBI) — proteins), complexportal (Complex Portal (EBI) — proteins), intact (IntAct (EBI) — proteins), chembl (ChEMBL (EBI) — chemistry), pubchem (PubChem (NCBI) — chemistry), chebi (ChEBI (EBI) — chemistry), bindingdb (BindingDB — chemistry), zinc (ZINC (CartBlanche, UCSF) — chemistry), rhea (Rhea (EBI) — chemistry), clinicaltrials (ClinicalTrials.gov — clinical), openfda (openFDA — clinical), opentargets (Open Targets Platform — clinical), civic (CIViC — clinical), clingen (ClinGen (erepo.genome.network) — clinical), cosmic (COSMIC via NLM Clinical Tables — clinical), depmap (Cell Model Passports (Sanger) — clinical), cbioportal (cBioPortal — clinical), geo (NCBI GEO — omics), arrayexpress (ArrayExpress / BioStudies (EBI) — omics), pride (PRIDE (EBI) — omics), metabolights (MetaboLights (EBI) — omics), mgnify (MGnify (EBI) — omics), encode (ENCODE Project — omics), jaspar (JASPAR (Elixir) — omics), unibind (UniBind (Univ. of Oslo) — omics), cellguide (CellGuide (CZI CELLxGENE) — cells), panglaodb (PanglaoDB — cells), antibodyregistry (Antibody Registry (RRID) — cells), ols (OLS4 (EBI) — ontology), quickgo (QuickGO (EBI) — ontology), identifiers-org (identifiers.org registry — ontology), ncbi-taxonomy (NCBI Taxonomy (E-utilities) — ontology), reactome (Reactome — ontology), kegg (KEGG — ontology), rfam (Rfam (EBI) — ontology), grantsgov (Grants.gov — funding). |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many rows came back |
| results | Yes | the rows the authority returned — wire into filter_items, check_rows or summarize_rows |
| envelope | Yes | the whole response, for a row shape this node's `results` does not name |
| authority | Yes | which authority answered, stated rather than implied |
| endpoints | Yes | the URLs actually called — the provenance a methods section needs |
| retrievedAt | Yes | when it was fetched, because a live lookup is a fact about a moment |
rank_next_testsBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| n | No | how many measurements the run would take. Only applies when mode is measurements. | |
| beta | No | the Beta prior's β — failures already believed in. Only applies when mode is trials. | |
| mode | 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 |
| alpha | No | the Beta prior's α — successes already believed in. Only applies when mode is trials. | |
| tests | No | the candidates, each `{id, hypothesis, power, alpha}` and optionally `cost`, `reads` (what it would read) and `label`. Only applies when mode is tests. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| ledger | 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. | |
| trials | No | how many trials the run would take. Only applies when mode is trials. | |
| beliefs | No | belief that each hypothesis is true, as `{hypothesisId: probability}` — given directly, or to override the ledger's. Only applies when mode is tests. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| noise_sd | No | the measurement noise, in the same units. Only applies when mode is measurements. | |
| prior_sd | No | how uncertain the mean is now, as a standard deviation. Only applies when mode is measurements. | |
| target_bits | No | a gain to reach: the answer says how many measurements it would take. Only applies when mode is measurements. |
Output Schema
| Name | Required | Description |
|---|---|---|
| best | Yes | the most informative candidate's id, or the mode's own answer in words |
| bits | Yes | the expected information gain of the top answer, in bits |
| gain | Yes | the gain itself: nats, bits, and the entropies before and after. Absent when candidate tests were ranked, where each one carries its own |
| note | Yes | why a ranking is short or empty, when it is |
| byCost | Yes | the same candidates ordered by gain per unit cost, when every one was priced |
| ranked | Yes | every ranked candidate: gain, gain per unit cost, the prior it stands on and the posterior each outcome would leave |
| result | Yes | the full answer, with the settings that produced it |
| beliefs | Yes | the belief each hypothesis was ranked against, and where it came from |
| samplesForTarget | Yes | how many measurements reach `target_bits`; null when no target was set |
rank_reference_genesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| cq_table | 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 and the result says so. | |
| normfinder_arm | 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. They answer DIFFERENT questions — grouped separates intra- from inter-group variation, ungrouped cannot — so this is a choice, not a fallback. Values: auto (Auto (grouped when the table says so)), ungrouped (Ungrouped (force)). Advanced. | auto |
Output Schema
| Name | Required | Description |
|---|---|---|
| genormM | Yes | geNorm's stepwise elimination: the M value of every target at every step |
| grouped | Yes | whether NormFinder ran its grouped arm, and why not when it did not |
| ranking | Yes | the consensus ranking, most stable first, with every algorithm's own rank beside it |
| pairwiseV | Yes | V(n/n+1), the pairwise variation that answers how many reference genes are enough. Below 0.15 an extra gene is not worth it (Vandesompele 2002) |
| perMethod | Yes | each algorithm's own order and 1-based ranks, so a consensus can be read back to the four opinions behind it |
| mostStable | Yes | the consensus winner, named |
| recommendedCount | Yes | the smallest n whose V(n/n+1) falls under 0.15, or 0 when none does. A 0 means this plate does not support the usual answer, not that the run failed |
rank_strategiesBRead-onlyInspect
Compare EVERY assembly chemistry this engine has against one set of parts, and say what each one costs and risks.
| Name | Required | Description | Default |
|---|---|---|---|
| parts | No | the parts to assemble, in order — order is meaningful for Type-IIS. Wire records in, or name project documents. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzyme | No | 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. | auto |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| order_by | 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 better)), primers (Primers (lower is better)), overhangFidelity (Overhang fidelity (higher is better)), weakestJunctionTm (Weakest junction Tm (higher is better)), framesBroken (Frames broken (lower is better)), diagnosticCutters (Diagnostic cutters (higher is better)), cost (Cost (lower is better)). | junctions |
| digest_enzymes | 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 a digest is only meaningful against enzymes you have. |
Output Schema
| Name | Required | Description |
|---|---|---|
| best | Yes | the chemistry at the top of the order you asked for — a position in that order, not a verdict. Null when no chemistry built these parts |
| ranked | Yes | every feasible strategy in order, each with every criterion and the reason for any it could not score |
| refused | Yes | the chemistries that produced nothing, each with the refusal it gave. Never dropped: 'this cannot be built that way, and here is why' is half the answer |
| criteria | Yes | the criteria themselves: what each one means and which direction is better |
| feasible | Yes | how many chemistries produced a construct from these parts |
| notScored | Yes | criteria NO strategy could score, with the reason — so an empty column says why it is empty |
rank_tradeoffsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | the column naming each candidate. Left unset, the first column. | |
| order | 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 (crowding distance), hypervolume (hypervolume contribution). | crowding |
| table | Yes | the candidates: a header row, then one row per candidate. Comma- or tab-separated, quoted cells allowed. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| filter | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| crowding | 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-II (normalized)), raw (raw gaps). Advanced. | normalised |
| maximise | No | the columns where higher is better, separated by commas. | |
| minimise | No | the columns where lower is better, separated by commas. | |
| reference | 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 range. Only applies when order is hypervolume. Advanced. | |
| keep_duplicates | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| front | Yes | the non-dominated candidates (front 1), most isolated first |
| order | Yes | what ordered candidates within a front: crowding or hypervolume |
| counts | Yes | rows in the table, filtered out, left out for an empty objective, ranked |
| fronts | Yes | how many candidates sit on each front |
| ranked | Yes | every candidate ranked: front, flag, crowding distance, the candidate that beats it, its objective values |
| reference | Yes | the reference point the hypervolume was measured from, and whether it was derived (hypervolume order only) |
| hypervolume | Yes | the objective space front 1 dominates up to the reference point (hypervolume order only) |
read_answer_windowARead-onlyInspect
Read one window of an answer that came back cut to the size budget: the tool, the same arguments, the field its notice named, and which items or characters to return. The answer is derived again, so the window is the one that was cut.
| Name | Required | Description | Default |
|---|---|---|---|
| tool | Yes | the tool whose answer was cut | |
| field | Yes | the field the notice named ('' for the answer itself) | |
| limit | No | ||
| offset | No | ||
| arguments | No | the same arguments as that call |
read_mgfARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | the MGF file's contents. | |
| title | No | return only the spectrum with this title; empty returns every spectrum. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | spectra returned |
| spectra | Yes | one row per spectrum: title, precursorMz, precursorIntensity, charges, mz, intensity |
read_mzmlBRead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | return only the spectrum with this native id; empty returns every spectrum. | |
| text | Yes | the mzML file's contents. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| msLevel | No | return only spectra at this MS level (0 returns every level). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | spectra returned |
| spectra | Yes | one row per spectrum: id, msLevel, scanStartTime, precursors, mz, intensity |
read_rdml_runARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| run | 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 | 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 and one imported there cannot differ. Values: summary (Summary - what every run in the file holds), curves (Amplification curves - Cycle,<reaction>,...), cq (Instrument Cq values - the wide Ct table plus its group column), genorm (Instrument Cq values - long Target,Sample,Cq), melt (Melting curves - Temperature,<reaction>,...), partitions (Digital PCR partition counts - Well,Sample,Target,Positives,Partitions). | summary |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| rdml_xml | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | data rows in `table`, excluding its header |
| runs | Yes | every run in the file and what it holds - reactions, curves, melt curves, instrument Cq values, partition counts, the declared partition volumes, targets and samples |
| table | Yes | the chosen run's table, as the text the matching tool's own parser takes. Empty when the run has nothing of that kind - which is a fact about the run, not a failure |
| groups | Yes | for `cq`: one sample name per row of the Ct table, already aligned to it. The group column relative quantification needs |
| omitted | Yes | what the import deliberately left out and why - wells whose Cq is RDML's -1 `not available`, and samples whose replicates do not square up across targets. Never padded and never zero-filled (a Ct of 0 is a fabricated measurement) |
| version | Yes | the RDML version the file declares (1.0-1.4). The reader's behaviour differs by version and a table without it is not reproducible |
read_sequencing_qcBRead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | which report this is; `auto` sniffs it. Values: auto (Detect from the contents), perbase (Per-base coverage table), plasmidsaurus (Plasmidsaurus summary). | auto |
| text | Yes | the file's contents — a per-base coverage TSV (pos / ref / reads_all), or the provider's summary text. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| step_window | 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 a real change in level is. Advanced. | |
| coverage_line | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| kind | Yes | which report was actually read |
| shape | Yes | the coverage track's SHAPE: its median, how many positions fall under the line and in how many separate runs, the longest such run with its coordinates and its floor, and the largest change in level with the position it is at |
| perbase | Yes | per-base coverage: positions counted, mean/min/max read depth, and how many positions reach 20x |
| reading | Yes | what the coverage track says, generated from the profile that was measured rather than from the request, with the provider's own sentence quoted as theirs |
| longestGap | Yes | positions in the longest unbroken stretch under the coverage line — the provider's first warning shape. 0 means no position falls under it; null for a Plasmidsaurus summary, which has no track |
| minCoverage | Yes | the LOWEST depth anywhere in the read — the number that decides whether a disagreement with the reference is believable. Null for a Plasmidsaurus summary, which measures no depth |
| depthProfile | Yes | the depth track drawn: the MINIMUM and the mean depth per window, with the coverage line and the track's median as rules, so a drop-out reads as a drop-out rather than being averaged away. Null for a Plasmidsaurus summary, which measures no track |
| plasmidsaurus | Yes | the whole parsed summary, including the raw text it came from |
| largestStepFold | Yes | the largest sustained rise in depth, as a multiple — the provider's second warning shape. Branch on this rather than re-deriving it from the profile. Null when no step could be measured (a track shorter than two windows, or a Plasmidsaurus summary): a 0 is not a fold |
| contaminationPct | Yes | Plasmidsaurus' contamination estimate, as a percentage. Null when the summary states none, and for a coverage table: a 0 would read as a clean run nobody measured |
| positionsAbove20x | Yes | positions at 20x or better, out of the total. Null for a Plasmidsaurus summary |
| contaminationSource | Yes | what the provider says the contaminant IS — the half of the estimate that tells you what to do about it. Null when the summary names none, and for a coverage table |
read_structureARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| text | 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 | 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 the FILE's, so it is not declared here — an out-of-range model is refused by name, with the range that exists. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| id | Yes | the 4-character entry id the file declares about itself, empty when it declares none |
| cell | Yes | unit cell and space group, absent for a determination with no crystal |
| atoms | Yes | atoms in the model described |
| title | Yes | the entry's own title line |
| chains | Yes | one row per chain: id, polymer kind, residue and atom counts, the author numbering range, and the observed one-letter sequence |
| extent | Yes | the longest side of the bounding box in angstroms — whether this will fit a pore, a groove or a box |
| format | Yes | which reader actually ran: `pdb`, `mmcif`, or `smallcif` for a core CIF (small-molecule crystallography, which shares the .cif extension with mmCIF and is a different dictionary) |
| method | Yes | the experimental technique(s) — genuinely more than one for a neutron/X-ray structure |
| models | Yes | conformers in the file; more than one means an ensemble |
| waters | Yes | ordered solvent molecules, counted separately from ligands |
| bFactor | Yes | min, max and mean isotropic B over every atom, or null when the file states none |
| dialect | Yes | the same answer in words, for a reply to quote |
| formula | Yes | the empirical formula the file STATES about itself (`_chemical_formula_sum`), empty when it states none. For a crystal structure it describes the contents of the CELL, so it can name more atoms than the sites listed |
| helices | Yes | helices the DEPOSITOR annotated (not a calculation over the coordinates) |
| ligands | Yes | non-water heteroatom components with how many copies of each — the ions, cofactors and bound compounds |
| strands | Yes | strands the depositor annotated |
| modified | Yes | modified residues with the standard residue each stands in for, from the file's own MODRES / _pdbx_struct_mod_residue — the only authoritative source for what a component like MSE IS |
| residues | Yes | residues in the model described, solvent included |
| warnings | Yes | lines the reader could not parse, named rather than dropped |
| sequences | Yes | the CONSTRUCT sequence per chain as the file declares it (SEQRES / _entity_poly), which includes residues that were never resolved |
| disulfides | Yes | disulfide bonds the file annotates |
| hasPolymer | Yes | whether any chain is a polymer. False for a core CIF and for a coordinate set holding only a ligand — where `chains`, `residues` and `sequences` describe a wrapper rather than a molecule, and `atoms` is a count of symmetry-independent SITES |
| resolution | Yes | diffraction limit in angstroms. 0 means the entry states NONE (an NMR determination has no resolution) — read `hasResolution` rather than treating 0 as sub-angstrom |
| hasResolution | Yes | whether the entry states a resolution at all |
read_structure_consensusARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| text | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | aligned sequences the support was measured over |
| pairs | Yes | base pairs the consensus states |
| roles | Yes | per column, what its glyph said: pair, hairpin, bulge, multifurcation, external, insertion or missing |
| columns | Yes | alignment width the annotation covers |
| support | Yes | per column, {observed, paired} or null where the column is unpaired — the denominator travels so a caller can say "no evidence" instead of drawing a zero |
| alphabet | Yes | which alphabet the `SS_cons` line was written in: `wuss`, `protein-dssp`, or `unknown` |
| pairList | Yes | every pair as {i, j}, plus `knotLetter` when it came from a pseudoknot letter rather than a bracket |
| pairTable | Yes | per column, its partner column or -1 — the same shape `pairTable` returns, so it wires straight into an arc drawing |
| medianSupport | Yes | the median, over pairs that any row spans, of the fraction of those rows forming a canonical or wobble pair. The panel's own headline number — a family whose structure is real sits high here, and a low value means the rows do not do what the annotation says |
read_variant_callsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | last base of the region, 1-based and inclusive. Needs `contig`. Unset is the contig's last record. | |
| file | 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. | |
| limit | No | how many matching records to return. The COUNT is always the full number of matches: this caps the rows, never the accounting. | |
| start | No | first base of the region, 1-based and inclusive, as VCF itself counts. Needs `contig`. Unset is the contig's first record. | |
| types | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| contig | 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. | |
| sample | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| info_key | No | keep only records carrying this INFO key; with `info_value`, only those where it equals that value. | |
| min_qual | 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. | |
| pass_only | 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. | |
| info_value | No | with `info_key`, the value that key must equal. | |
| include_missing_qual | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| read | Yes | how many records were read before filtering. For a locus read this is the records in that window, NOT the file (`scope` says which) |
| scope | Yes | whether the numbers describe the whole file or one region, and (when the file was too large to read whole) that its header alone was opened. A count read from a window must never be readable as the file's |
| matched | Yes | how many records matched: the full count, not the number of rows returned |
| samples | Yes | the call set's sample names in header order, empty for a sites-only VCF, which is a fact about the file rather than a failure |
| summary | Yes | what was read and what matched, in one sentence generated from this run |
| variants | Yes | the matching records, up to `limit`: chrom, pos (1-based), ids, ref, alts, qual, filters, end and the record's own htslib class label. Genotypes are not included: `sample` filters on them and `variant_call_summary` counts them, and a cohort record would otherwise carry thousands of columns per row |
| filters_applied | Yes | every filter this run actually applied, with its value. A caller comparing two runs needs to know which asked the narrower question |
recombineBInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| site1 | 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 | No | the recombinase's second half-site (e.g. attB), same convention. Only applies when system is recombinase. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| greedy | No | permissive att core matching. Only applies when system is gateway-BP or gateway-LR. Advanced. | |
| guides | 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. | |
| system | 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-sites)), homologous (Homologous recombination (shared arms)), crispr-knock-in (CRISPR knock-in (guide-gated HR)). | gateway-LR |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| fragments | No | the molecules to react — wire upstream `record` outputs here, or name library documents. | |
| homology_bp | No | shortest homology arm that counts as a shared end. In bp. Only applies when system is homologous or crispr-knock-in. | |
| circular_only | No | report only circular products. | |
| include_subject | No | also include the node's subject as a reactant. | |
| multi_site_only | No | keep only products where BOTH sites recombined (drops single-site intermediates). Only applies when system is gateway-BP or gateway-LR. |
Output Schema
| Name | Required | Description |
|---|---|---|
| sites | Yes | per-input report of the recombination sites found |
| record | Yes | the first product, as a record |
| products | Yes | every product |
| discarded | Yes | CRISPR knock-in only: products dropped because a guide also cuts OUTSIDE the repair. A non-zero count is a finding about the guide, not a warning to swallow |
| productCount | Yes | number of products |
recompute_trace_qualityARead-onlyInspect
Re-score a Sanger trace's own base calls from the signal, replacing the instrument's Phred values with ones measured from the peaks.
| Name | Required | Description | Default |
|---|---|---|---|
| table | 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. | 3730pop7 |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| bases | Yes | how many bases the reading called |
| meanQuality | Yes | the mean Phred of the reading, on the calibration table it names |
| instrumentBases | Yes | how many the FILE carries, so a gate can see a de-novo reading change the read's length |
record_compositionBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| doubleStranded | 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 is a parameter and not a guess. Defaults to true, or false when the record is RNA (U and no T), which is also weighed with RNA residue masses. |
Output Schema
| Name | Required | Description |
|---|---|---|
| length | Yes | symbols in the record, non-standard ones included |
| strands | Yes | how many strands the mass was taken over: 2, 1, or 0 for a protein where the question does not arise |
| atPercent | Yes | percent A+T over the same denominator. Null for a protein |
| gcPercent | Yes | percent G+C over the RESOLVED A/C/G/T bases (`standardCount`), which is Biopython's gc_fraction default (ambiguous="remove") — not over the full length, so it complements `atPercent` exactly. Null for a protein |
| extinction | Yes | protein subjects only: e280 under both cystine conventions; null otherwise |
| composition | Yes | one row per standard symbol: code, label, count, and its percent of `standardCount` |
| nonStandard | Yes | the symbols the alphabet does not define — Ns, IUPAC ambiguity codes, gaps — with counts and NO share, because they are excluded from the denominator |
| standardCount | Yes | how many of `length` are standard — the denominator every share here is over |
| molecularWeight | Yes | molecular weight — g/mol for a nucleic acid under `doubleStranded` and the record's own topology, Da for a protein |
| isoelectricPoint | Yes | protein subjects only (ProtParam, Bjellqvist); null otherwise |
record_experimentAInspect
Write what just happened into your lab notebook: a new entry, or more text appended to one you name.
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | tags to file it under, beyond the `automated` tag every entry written here carries. | |
| title | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| body_md | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| entry_id | 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. | |
| collection | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| tags | Yes | the tags as stored, including `automated` — the engine caps and cleans these, so read them back rather than assuming |
| title | Yes | the title it now carries |
| created | Yes | true for a new entry, false when text was appended to an existing one |
| entry_id | Yes | the entry written — pass it back to append to this same experiment next time |
| bodyChars | Yes | the stored body length. The engine caps a body at 1,000,000 bytes, so a long append can be shorter here than what was sent — read it rather than assuming the write was whole |
| crossRefs | Yes | the @plasmid / !action / &gel references the engine extracted from the body — empty lists are a real answer and mean the body named no construct, which is worth noticing in an entry about one |
| collection | Yes | the collection it is filed in, or an empty string when it is filed in none |
| unresolved | Yes | `{ references, citations }`: every `@` / `!` / `&` reference in the stored body that names nothing in this workspace, as written, and every citation key that is not a DOI, PMID or PMCID. Empty lists mean every reference resolves; fix and append when they are not. Null when the write ran without the check (a blocking workflow run) |
relative_expressionBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| tube | No | `separate_tube`: target and reference amplified in different wells, errors independent. `same_tube`: multiplexed in one well, subtracted per well before averaging. Advanced. | separate_tube |
| model | 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 series rather than assuming efficiency. Values: delta_delta_ct (Delta-delta-Ct (normalised + calibrated)), delta_ct (Delta-Ct (calibrated only)), relative_curve (Standard curve (fitted amounts)). | delta_delta_ct |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| groups | 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`). | |
| amounts | 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. | |
| lm_mode | 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 − reference)), divide (Divide (target ÷ reference)). Only applies when sig_test is lm.design. Advanced. | subtract |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| ct_table | 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. | |
| sig_test | 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.test` is the rank-sum test, for plates too small or too skewed to assume normality; `lm.design` fits `lm(norm ~ model_matrix + 0)` for designs the two-group form cannot express, and is reported through `design` rather than the test table. Values: none (None), t.test (Welch t-test), lm (Linear model (two-group)), wilcox.test (Wilcoxon rank-sum), lm.design (Design-matrix linear model). Advanced. | none |
| lm_formula | 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.design. Advanced. | ~ group |
| lm_variables | 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 factor - the same distinction R makes. Leave empty to model on `group` alone. Only applies when sig_test is lm.design. Advanced. | |
| wilcox_exact | 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; `normal` forces the approximation. Values: auto (Auto (exact if both groups < 50)), exact (Exact conditional), normal (Normal approximation). Only applies when sig_test is wilcox.test. Advanced. | auto |
| lm_conf_level | No | confidence level for the `lm.design` coefficient intervals. Only applies when sig_test is lm.design. Advanced. | |
| reference_gene | 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 relative_curve. | |
| wilcox_correct | 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 (Continuity), 1 (Continuity + Edgeworth 1), 2 (Continuity + Edgeworth 2), 3 (Continuity + Edgeworth 3). Only applies when sig_test is wilcox.test. Advanced. | continuity |
| reference_group | Yes | the group everything is calibrated against: the untreated / time-zero / wild-type arm. | |
| assess_efficiency | 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 rather than assumed - a slope far from zero says delta-delta-Ct is the wrong model for this plate. Needs `standard_ct_table` and `amounts`. Advanced. | |
| standard_ct_table | 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. | |
| wilcox_conf_level | No | confidence level for the Wilcoxon location-shift interval. Only applies when sig_test is wilcox.test. Advanced. | |
| wilcox_alternative | 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. | two.sided |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | one row per group x gene: the normalised and calibrated delta-Ct (or fitted amount ratio), the fold change and its bounds |
| test | Yes | the significance test beside the model - one row per gene, with the statistic, p value and interval - or null when none was asked for |
| count | Yes | how many rows the model produced |
| genes | Yes | the genes measured, reference gene excluded under delta-delta-Ct |
| model | Yes | the model that produced them |
| trend | Yes | the per-gene standard curve (intercept, slope, R-squared) the `relative_curve` model consumed, or null |
| design | Yes | the design-matrix linear model: the formula, the columns it built, and per gene a coefficient table WITH the fit diagnostics. Null unless `sig_test` is `lm.design` |
| groups | Yes | the groups, in the order the rows use |
| efficiency | Yes | the equal-efficiency check: delta-Ct regressed on log10 amount per gene. A slope far from zero says delta-delta-Ct is the wrong model here. Null unless `assess_efficiency` ran |
| referenceGene | Yes | the gene every target was normalised to under delta-delta-Ct; null for the models that use none |
| standardPoints | Yes | the dilution observations behind that curve, with fitted values and residuals - a standard curve is judged by whether a dilution sits off the line, not by R-squared |
remember_lab_preferenceBInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| clear | No | preferences to forget, so those panels start on their own defaults again. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| polymerase | 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)). | keep |
| primer_gc_max | No | highest primer GC, %. | |
| primer_gc_min | No | lowest primer GC, %. | |
| expression_host | No | the organism codon optimization targets: a scientific name or an NCBI taxonomy id. | |
| primer_length_max | No | longest primer, nt. | |
| primer_length_min | No | shortest primer, nt. | |
| polymerase_product | 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 (Takara Bio · TaKaRa Ex Taq / EmeraldAmp MAX), takara-la-taq (Takara Bio · TaKaRa LA Taq), takara-ex-premier (Takara Bio · TaKaRa Ex Premier), primestar-gxl (Takara Bio · PrimeSTAR GXL DNA Polymerase), primestar-hs (Takara Bio · PrimeSTAR HS DNA Polymerase), primestar-max (Takara Bio · PrimeSTAR Max DNA Polymerase Ver.2), primestar-longseq (Takara Bio · PrimeSTAR LongSeq DNA Polymerase), cloneamp-hifi (Takara Bio · CloneAmp HiFi PCR Premix), speedstar-hs (Takara Bio · SpeedSTAR HS DNA Polymerase), terra-direct (Takara Bio · Terra PCR Direct Polymerase Mix), titanium-taq (Takara Bio · Titanium Taq DNA Polymerase), advantage-hd (Takara Bio · Advantage HD Polymerase Mix), qiagen-taq (QIAGEN · Taq DNA Polymerase), qiagen-hotstartaq (QIAGEN · HotStarTaq DNA Polymerase). Only applies when polymerase is taq or dbd. | generic |
Output Schema
| Name | Required | Description |
|---|---|---|
| changed | Yes | which preferences this call set or cleared |
| reading | Yes | the saved preferences in one sentence, as the assistant reads them each turn |
| preferences | Yes | every lab preference as saved after this call; null where none is set |
research_run_statusARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| run | Yes | the run file run_discovery_programme or resume_research_run returned. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequences | No | optionally, the corpus as it is now, to check against the run's pinned inputs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| drift | Yes | pinned inputs whose content changed, when a corpus was given; null when none was |
| status | Yes | id, hypothesis counts by verdict, pending and settled hypotheses, and the next action |
| pending | Yes | hypotheses a resume would run |
| decisions | Yes | every hypothesis's verdict, merged e-value, tests and merge rule |
resolve_gene_setsARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| genes | 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). Only applies when authority is reactome. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| organism | Yes | the organism: an NCBI taxon ID (7227) or a name (Drosophila melanogaster, human); GO resolves it through NCBI Taxonomy, Reactome resolves it itself. | |
| authority | 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). | go |
Output Schema
| Name | Required | Description |
|---|---|---|
| geneSets | Yes | the sets as GMT text: ID, name, member genes |
| provenance | Yes | the authority, the organism it resolved, its release, the retrieval date, every URL read and what the sets are restricted to |
restore_trace_file_callsAInspect
Put an open Sanger read back on the base calls its FILE carries, undoing an adopted re-call.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| bases | Yes | how many bases the file's own reading carries |
| sequence | Yes | the read the document now carries |
restriction_ligateAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| blunt | No | allow blunt-end joins as well as sticky. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | No | the enzymes in the pot — used for every input. Left unset, the run uses your active enzyme collection. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| fragments | No | the molecules to put in the pot — wire upstream `record` outputs here, or name library documents. | |
| end_origins | 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 original terminus — reachable only when it arrives already sticky, which today means an annealed oligo adapter. Advanced. | |
| circular_only | No | report only circular products. | |
| end_treatments | No | the phosphatase or kinase applied to each input, positionally. Same reach as `end_origins`: an original sticky terminus only. Advanced. | |
| include_subject | No | also put the node's subject in the pot. | |
| sort_by_recognition_sites | No | sort products by how many sites of the FIRST enzyme they still carry, fewest first — this floats the finished construct to the top. |
Output Schema
| Name | Required | Description |
|---|---|---|
| layout | Yes | where each piece and join sits ON the product: the spans the map draws |
| record | Yes | the first product, as a record — with the sort on, the one carrying the fewest remaining sites |
| products | Yes | every product |
| junctions | Yes | the junctions formed, with the overhang each was made by — wire into score_overhang_fidelity |
| productCount | Yes | number of products (>1 = the pieces go together more than one way) |
| nickedJunctions | Yes | indices of junctions left NICKED by a missing 5'-phosphate on one strand — the product still transforms and is repaired in vivo |
| recognitionSites | Yes | sites of the FIRST enzyme still in the first product. 0 = finished: the reaction cannot re-cut it |
| partiallyDigested | Yes | inputs whose products were DROPPED because they would have needed a partial digest — a product that needs the enzyme to skip a site it must have cut is not a bench outcome |
resume_research_runARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| run | Yes | the run file to continue. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequences | No | the corpus the run was registered over: library document or file names, or wired records. | |
| budget_seconds | 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. A test is never cut short and at least one runs per call. Unset: every test runs in this call. In s. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| run | Yes | the whole program as a sealed jane.research-run file: the ledger, every corpus input pinned by SHA-256, the last attempt at each hypothesis. Pass it back to continue |
| report | Yes | the resume as text lines: what ran, what was refused, the verdicts |
| resumed | Yes | the hypotheses this call ran |
| decisions | Yes | every hypothesis: verdict, merged e-value, tests and merge rule |
reverse_complementAInspect
Reverse-complement the subject sequence. Emits a NEW record, so downstream nodes (map, digest, gel, ORF) run on the revcomp rather than the original.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| record | Yes | the reverse-complemented record |
| sequence | Yes | reverse complement 5'→3' |
rps_blast_cddBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| db | 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. | cdd |
| dna | 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. | |
| dmode | 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). | std |
| smode | 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 (precomputed only), live (live search). | auto |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| evalue | No | E-value cutoff; live mode only (automatic and precomputed apply 0.01). Only applies when smode is live. | |
| filter | No | mask low-complexity regions of the query before searching. | |
| maxhit | No | most hits per protein; live mode only (automatic and precomputed apply 500). Only applies when smode is live. | |
| protein | No | the protein sequence, one-letter codes; wire it from translate_sequence or read it off a CDS. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| compbasedadj | No | 0 no composition-based statistics · 1 composition-based statistics · 2 composition matrix adjust · 3 forced full matrix adjust. |
Output Schema
| Name | Required | Description |
|---|---|---|
| hits | Yes | every domain hit: queryLabel (the frame, for a `dna` query), hitType, pssmId, from, to (1-based residues), evalue, bitscore, accession, shortName, incompleteN, incompleteC, superfamily, definition |
| cdsid | Yes | NCBI's search id, re-openable in CD-Search's own viewer for two days |
| count | Yes | domain hits returned |
rps_blast_smartARead-onlyInspect
rpsblast, run on this machine: find conserved domains in a protein against NCBI's SMART domain models (1,011 PSSMs from CDD).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| evalue | No | report alignments with E at most this (`-evalue`); BLAST's default is 10. | |
| source | 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. | bundled |
| protein | Yes | the protein, one-letter codes; wire it from translate_sequence or read it off a CDS. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| max_target_seqs | No | most domain models reported (`-max_target_seqs`). |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | domain models hit |
| domains | Yes | every SMART domain hit, best first: accession, shortName, title, profileLength and each HSP's residue coordinates, model coordinates, score, bits, E-value, identities, positives, gaps and aligned strings |
rpstblastn_smartARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| evalue | No | report alignments with E at most this (`-evalue`); BLAST's default is 10. | |
| source | 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. | bundled |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the DNA to search, 5′→3′; leave empty to search the open record. Both strands are searched. | |
| genetic_code | No | NCBI genetic code used to translate the six frames (`-query_gencode`). | |
| max_target_seqs | No | most domain models reported (`-max_target_seqs`). | |
| comp_based_stats | No | composition-based statistics: 1 on (the default, Schäffer et al. 2001), 0 off. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | domain models hit |
| domains | Yes | every SMART domain hit, best first: accession, shortName, title, profileLength and each HSP's nucleotide coordinates (1-based, to < from on the minus strand) and frame, model coordinates, score, bits, E-value, identities, positives, gaps and aligned strings |
run_discovery_programmeARead-onlyInspect
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; discover_tree_incongruence: a locus of a multi-locus alignment, by the ILD test; discover_gene_tree_discordance: a gene alignment against a species tree, by the SH test; discover_reference_stability: a candidate reference gene against its GTEx abundance peers; discover_annotation_contradictions: a UniProt signal peptide or transmembrane segment against the experimentally confirmed ones; discover_reference_concordance: a Cq table whose conditions should rank its reference genes alike; differential_expression: a gene of a DESeq2 fit, up or down in the contrast; gene_set_overrepresentation: a gene set holding more of a gene list than chance; gene_set_enrichment: a gene set toward the top or bottom of a ranked list by GSEA) and direction, and all are registered in a hypothesis ledger before any test runs.
| Name | Required | Description | Default |
|---|---|---|---|
| run | 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 again. | |
| alpha | No | e-BH level the verdicts are decided at, across every hypothesis in the ledger. | |
| kappa | No | κ of the p-to-e calibrator e = κ·p^(κ−1); fixed for a ledger once it holds evidence. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| ledger | No | a ledger file from an earlier run, to continue: its hypotheses keep their evidence and new ones are added beside them. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| organism | No | the organism the corpus is from, for the literature query each supported hypothesis needs. Advanced. | |
| sequences | No | the corpus every registered test runs over: library document or file names, or wired records. | |
| hypotheses | 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 two-sided) or discover_codon_outliers (params gene as its library name, genetic_code, alt_init?, min_codons?; direction two-sided) or validate_gene_trait (params gene as its HGNC symbol, expression_test coexpression with trait_genes or tissue with tissues, categories as GWAS Catalog parent categories, alpha?; direction greater; needs no corpus) or discover_flag_rates (params flag as one of sigma70-strongest, splice-donor, splice-acceptor, homopolymer, tandem-repeat, long-repeat, inverted-repeat, record?, shuffle_k/shuffles/seed; direction greater, meaning beyond chance in the flag's own tail) or discover_tree_incongruence (params locus as its alignment file's name, permutations/seed; direction greater; the corpus is one aligned FASTA per locus) or discover_gene_tree_discordance (params gene as its alignment file's name, species_tree in Newick, replicates/sh_form/gamma_categories/seed; direction greater, meaning the gene fits another tree better; the corpus is one aligned FASTA per gene) or discover_reference_stability (params gene as its HGNC symbol, tissues?, neighbours?, pseudocount?; direction greater for more variable than its abundance peers, less for steadier, or two-sided; needs no corpus) or discover_annotation_contradictions (params annotation as a UniProt accession, or accession:start-end where the protein has several, feature signal or transmembrane, predictor for signal, decoding for transmembrane; direction less, meaning it scores below the experimentally confirmed features; needs no corpus) or discover_reference_concordance (params cq_table as the long-format Target,Sample,Group,Cq table itself, permutations/seed; direction greater, meaning the conditions rank the genes more alike than independent orders; needs no corpus) or differential_expression (params gene as its count-table ID, symbol? as papers name it for the literature query, counts and samples as the tables themselves, and design/reference/test/reduced/contrast/name/fitType/sfType/lfcThreshold/altHypothesis/cooksFilter/cooksCutoff/minReplicatesForReplace as the tool takes them; direction greater for higher in the contrast's numerator, less for lower, or two-sided; one-sided needs the Wald test at lfcThreshold 0; needs no corpus) or gene_set_overrepresentation (params set as its GMT ID, genes, geneSets as GMT text, universe?, forceUniverse?, minGSSize?, maxGSSize?; direction greater; needs no corpus) or gene_set_enrichment (params set as its GMT ID, ranked as 'gene statistic' lines, geneSets as GMT text, minGSSize/maxGSSize/exponent/scoreType/eps/sampleSize/nPermSimple/seed; direction greater for toward the top of the list, less for the bottom, or two-sided; needs no corpus). prior_belief: the proposer's belief before any result, one sample or a list of them (true, false, definitely true, maybe true, uncertain, maybe false, definitely false, cannot comment). | |
| budget_seconds | 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. A test is never cut short and at least one runs per call. Unset: every test runs in this call. In s. Advanced. | |
| posterior_beliefs | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| run | Yes | the whole program as a sealed jane.research-run file: the ledger, every corpus input pinned by SHA-256, the last attempt at each hypothesis. Pass it back to continue |
| ledger | Yes | the whole ledger as a jane.discovery-ledger file, every hypothesis and its evidence with traces |
| report | Yes | the program as text lines: registrations, runs, refusals, verdicts, literature queries |
| result | Yes | the full result |
| followUp | Yes | hypotheses with prior and posterior beliefs, most surprising first: what to test next, never a verdict |
| decisions | Yes | every hypothesis: verdict (supported, not-supported, no-evidence), product e-value and tests |
| supportedCount | Yes | how many hypotheses e-BH supports |
run_gel_laneBRead-onlyInspect
Resolve a gel lane (ladder / plasmid / digest / pcr) into [bp, form] bands for the open plasmid.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| detail | 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. | |
| source | Yes | what this lane holds. Values: ladder (DNA ladder), plasmid (Uncut plasmid), digest (Restriction digest), pcr (PCR product). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| product_bp | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| bands | Yes | [bp, form] gel bands |
run_gel_plateBRead-onlyInspect
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 outside the resolving window of the agarose percentage cast, two fragments co-migrating as one drawn band, a DNA form the chosen law cannot move, an empty lane, and a refused calibration.
| Name | Required | Description | Default |
|---|---|---|---|
| form | 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 says so rather than leaving the setting silently inert. Advanced. | linear |
| lanes | 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 here. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| ladder | 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)), generuler_1kb (GeneRuler 1 kb (250–10,000)), generuler_100bp (GeneRuler 100 bp (100–3,000)), generuler_100bp_plus (GeneRuler 100 bp Plus (100–3,000)), thermo_1kb_plus (Thermo 1 Kb Plus (100–15,000)), neb_1kb (NEB 1 kb (500–10,000)), neb_100bp (NEB 100 bp (100–1,517)), lambda_hindiii (Lambda DNA / HindIII (125–23,130)), penn_state (PennState (500–10,000)). | generuler_1kb_plus |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| lane_names | 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. | |
| render_mode | 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. | bands |
| mobility_model | 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)), rill-van-winkle (Rill/Van Winkle). Only applies when agarose_percent is set. Advanced. | helling-goodman-boyer |
| agarose_percent | 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 with no concentration term. In %. |
Output Schema
| Name | Required | Description |
|---|---|---|
| bands | Yes | every placed band: lane, length in bp, Rf and migration on the shared coordinate system, and whether this gel can measure it |
| cautions | Yes | only the cautions this plate earned, each carrying the measurement that produced it and naming the lane it is about. Empty when every band is measurable |
| conclusion | Yes | the one-sentence reading, generated from this run: lanes, bands, the size range they span, and the ladder that positioned them |
| derivation | Yes | the machinery, one row per fact: what placed the lanes, the ladder that calibrated them and whether its curve is its own or borrowed, the resolving window, each lane`s DNA form, and how the plate is drawn |
| calibratedBy | Yes | the ladder whose measured curve positioned every lane — which is NOT always the ladder drawn: 2 of the 10 built-ins carry (bp, Rf) points, and a gel showing one of the other 8 is positioned on the default curve |
| unmeasurable | Yes | per lane, the two failures kept apart because different actions fix them: `offScale` (outside the reference ladder entirely — read it off the table) and `outOfWindow` (inside the ladder, outside this percentage`s resolving range — cast a different gel) |
run_workflowBInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| graph | 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 `scatter` (run it once per element of a list input, gathering every output into an array). | |
| _files | 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 library document a tool can name in its `sequences`/`parts`/`document` arguments (a multi-record file as `file · record`), and a tool reading a file by name (a trace, an alignment) finds it here. | |
| _subject | 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 it here or refuses by name. |
save_enzyme_collectionAInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | what to call the collection, as it will read in the panel. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | 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 | No | overwrite a collection that already has this name. Left false, a name clash refuses and says which collection it would have replaced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| activate | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many enzymes it holds |
| active | Yes | whether this collection is now the one an unset enzyme parameter resolves to |
| created | Yes | true for a new collection, false when an existing one of the same name was replaced |
| enzymes | Yes | the names as saved, de-duplicated in the order given — wireable straight into a scan |
| collection | Yes | the name it was saved under |
scaffold_networkBRead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| rules | No | which bonds are cut. Values: rings (Ring side of each cut), brics (BRICS, both sides). | rings |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| molecules | Yes | the structures: one SMILES or molfile per entry. |
Output Schema
| Name | Required | Description |
|---|---|---|
| edges | Yes | every edge: from and to node indices and its RDKit type |
| nodes | Yes | every node: SMILES, the input indices containing it, times made |
| summary | Yes | the network in words, generated from this run |
scan_intrinsic_terminatorsARead-onlyInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the DNA to scan - leave unset to use the open record. | |
| region_end | No | 0-based inclusive end. Unset = the whole sequence. Advanced. | |
| max_results | No | how many to return, best hairpin first. Advanced. | |
| both_strands | 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. | |
| region_start | No | 0-based inclusive start of the region to scan. Unset = the whole sequence; pass the selection's start to scope to it. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many are reported |
| offset | Yes | where the scanned stretch starts in the sequence: add it to every position above for sequence coordinates. 0 unless a region was given |
| strongest | Yes | the best-folding candidate, or null when none cleared both cutoffs |
| terminators | Yes | the candidates, best hairpin first, each with its stem-loop, its tail, the stem length and both scores |
| strongestHairpin | Yes | that candidate's hairpin score on its own, for a threshold downstream (lower is stronger). null when none cleared both cutoffs: there is no hairpin to score, and a 0 would pass a threshold as a measured value |
scan_motif_sitesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| motifs | 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 | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the DNA to scan - leave unset to use the open record. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many matches in total |
| sites | Yes | every match, by position: motif name, start and end (0-based, end exclusive), strand, log-odds score and its fraction of the matrix's range |
| perMotif | Yes | the number of matches for each motif, by name |
scan_protein_domainsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| 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 EBI with the job and stored nowhere by this tool. | ||
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| sortBy | 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). | length |
| goTerms | No | ask InterPro to attach Gene Ontology terms to the integrated entries, so a match carries its function rather than only its accession. | |
| protein | Yes | the protein sequence, one-letter codes; wire it from translate_sequence or read it off a CDS. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| pathways | No | ask InterPro to attach pathway cross-references (Reactome, KEGG, MetaCyc) to the integrated entries. | |
| maxEvalue | 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 threshold, it was never scored against one. | |
| applications | 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. An id the live service does not advertise is refused by name rather than dropped. | |
| integratedOnly | No | keep only signatures integrated into an InterPro entry, dropping member-database hits InterPro has not curated into one. | |
| visibleLibraries | 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` narrows what is RUN, and they are not the same question — a caller reading one library out of the service's default set wants this one. Empty keeps every database that answered. | |
| representativeOnly | No | keep only the matches InterProScan itself marks representative — its own answer to “which of these overlapping signatures describes this region best”. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | matches returned, after the reading knobs |
| jobId | Yes | EBI's own job id, which is re-fetchable at their dispatcher for as long as they keep it — the provenance of this result, not an internal handle |
| domains | Yes | the FOLDED regions only — domains, as `start-end@label` residue ranges — ready to wire straight into find_linear_motifs.domains so its globular-domain filter can bury motifs in them. Families, signal peptides, transmembrane helices, coiled coils and disordered spans are excluded: those are not folds a motif can hide inside, and disorder is where linear motifs live |
| matches | Yes | every signature that matched, after the reading knobs: member database, signature accession and name, the InterPro entry it is integrated into, its kind (domain, family, site, repeat, homologous superfamily…), 1-based inclusive aaStart/aaEnd, the fragments a discontinuous domain is made of, the E-value and the GO and pathway cross-references |
| provenance | Yes | the InterProScan version that ran, the MD5 the service computed over the sequence it analyzed, the member databases asked for, how many matches the scan returned before the reading knobs, and which of those knobs ran |
scan_sigma70_promotersARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| max_dg | 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 rather than a set of calls, and inventing a floor here is the exact defect the scanner this replaces had. Set it when you have a threshold of your own. In kcal/mol. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the DNA to scan - leave unset to use the open record. | |
| region_end | No | 0-based inclusive end. Unset = the whole sequence. Advanced. | |
| max_results | No | how many to return, strongest (most negative) first. Advanced. | |
| both_strands | 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. | |
| region_start | No | 0-based inclusive start of the region to scan. Unset = the whole sequence; pass the selection's start to scope to it. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many are reported (`max_results`, or fewer if the sequence is short or `max_dg` was set) |
| offset | Yes | where the scanned stretch starts in the sequence: add it to every position above for sequence coordinates. 0 unless a region was given |
| promoters | Yes | the configurations, strongest (most negative) first, each with its six motif sequences, their positions and the per-motif energies that sum to its total |
| strongest | Yes | the most negative ΔG_total, or null when the sequence is too short to hold one |
| strongestDg | Yes | that hit's ΔG_total on its own, for a threshold downstream, or null when there is no hit |
scan_splice_sitesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| strand | 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, and the other strand's candidates stop crowding the ranking. | both |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| sequence | No | the DNA to scan - leave unset to use the open record. | |
| min_maxent | 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 a classifier, so a default here would be a decision boundary nobody has published. Set it when you have a threshold of your own. In bits. | |
| max_results | No | how many to return, strongest first. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many are reported |
| sites | Yes | the candidates, strongest MaxEnt first, each with its kind, position on the strand you passed, the window that was scored, and both scores |
| strongest | Yes | the highest-scoring candidate, or null when the sequence is too short to hold a window |
| strongestMaxEnt | Yes | that candidate's MaxEntScan score on its own, for a comparison downstream, or null when there is no candidate: 0 is a real MaxEntScan score |
score_overhang_fidelityBRead-onlyInspect
Score a Golden Gate junction (fusion-site) set against MEASURED T4 DNA ligase end-joining data.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzyme | No | the Type-IIS enzyme the reaction uses, which picks that enzyme's own measured matrix when one exists. Only applies when dataset is not given. | |
| dataset | No | score against this measured matrix instead of the one the enzyme implies. Values: BsaI-HFv2 (BsaI-HFv2, Golden Gate cycling (4 nt)), BsmBI-v2 (BsmBI-v2, Golden Gate cycling (4 nt)), Esp3I (Esp3I, Golden Gate cycling (4 nt)), BbsI-HF (BbsI-HF, Golden Gate cycling (4 nt)), SapI (SapI, Golden Gate cycling (3 nt)), T4-01h-25C (T4 DNA ligase, 1 h at 25 C (4 nt)), T4-01h-37C (T4 DNA ligase, 1 h at 37 C (4 nt)), T4-18h-25C (T4 DNA ligase, 18 h at 25 C (4 nt)), T4-18h-37C (T4 DNA ligase, 18 h at 37 C (4 nt)). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| remedies | No | also compute what to CHANGE: the drop-the-worst repair, and replacement candidates for each flagged junction. Off makes the run cheaper on a large set. | |
| overhangs | Yes | the junction overhangs, one per junction, top strand (e.g. AATG, GCTT). Wire `golden_gate_assemble.overhangs` here, or list them. | |
| replacements_per_junction | No | how many replacement candidates to rank per flagged junction. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| flags | Yes | weak, self-misannealing and cross-misannealing junction indices, plus the structural verdict |
| worst | Yes | the weakest junctions, worst first: what to change to raise the score |
| repair | Yes | the drop-the-worst repair: which junctions to remove, what is left, and the fidelity that leaves. Null when `remedies` is off |
| dataset | Yes | the measured matrix actually scored against |
| percent | Yes | the same number as a percentage, which is how every incumbent reports it |
| fidelity | Yes | expected fraction of fully-correct assemblies, 0-1 |
| junctions | Yes | per junction: overhang, correct/total measured events, its own fidelity, Watson-Crick strength, and its strongest mismatch partners |
| meaningful | Yes | false when a STRUCTURAL error makes the fidelity number misleading rather than merely bad: do not present `fidelity` on its own when this is false |
| replacements | Yes | per FLAGGED junction, the best overhangs to swap in, each with the whole set’s fidelity after the swap. Empty when `remedies` is off |
| atMeasurementCeiling | Yes | true when NO mismatch ligation was measured between any two junctions, so the score is exactly 100%: the floor the source experiment can resolve, not a guarantee |
score_rbsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| mrna | No | the mRNA (or DNA) carrying the UTR and the CDS — leave unset to use the open record. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| start_pos | Yes | 0-based position of the start codon's first base within `mrna`. |
Output Schema
| Name | Required | Description |
|---|---|---|
| dgMrna | Yes | folding energy of the mRNA window that competes with initiation |
| dgTotal | Yes | total free energy of the initiation state (null when no Shine-Dalgarno could be placed) |
| sdStart | Yes | 0-based position in `mrna` where the winning Shine-Dalgarno begins (null when none could be placed) |
| spacing | Yes | bases between the Shine-Dalgarno and the start codon (null when no Shine-Dalgarno could be placed) |
| dgHybrid | Yes | Shine-Dalgarno · anti-SD hybridisation energy (null when no Shine-Dalgarno could be placed) |
| sdLength | Yes | length of that Shine-Dalgarno, in bases (null when no Shine-Dalgarno could be placed) |
| structure | Yes | dot-bracket secondary structure of the folded initiation window (empty when the window is too short to fold) |
| relStrength | Yes | relative initiation strength (higher = stronger) |
| structureStart | Yes | 0-based position in `mrna` that the first character of `structure` sits on |
score_spectrumARead-onlyInspect
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!).
| Name | Required | Description | Default |
|---|---|---|---|
| mz | Yes | observed peak m/z values. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| peptide | Yes | candidate peptide, one-letter residues with optional ProForma tags (a signed mass, a Unimod name, or UNIMOD:accession). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| intensity | Yes | observed peak intensities, one per m/z. | |
| tolerance | No | fragment match tolerance. | |
| toleranceUnit | No | unit of the tolerance. | Da |
| precursorCharge | No | precursor charge; fragments are generated at charges 1 to max(1, charge - 1). |
Output Schema
| Name | Required | Description |
|---|---|---|
| score | Yes | HyperScore (natural log scale; higher is a better match) |
| detail | Yes | matched b and y ion counts, mean match error, theoretical peak count |
| matches | Yes | one row per matched ion: ion name, theoretical and observed m/z, intensity, error in the tolerance unit |
score_variant_effectARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| model | 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 (ESM-2 35M · 134.5 MB), esm2_t33_650M (ESM-2 650M · 2.61 GB). | esm2_t6_8M |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| protein | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| strategy | 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 it as weaker. `pseudo-ppl` scores the whole mutant sequence and costs one pass per residue PER VARIANT, which is two orders of magnitude more; its number is a log-likelihood, not a ratio, and is comparable only against other variants of the same protein. Values: wt-marginals (Wild-type marginals), masked-marginals (Masked marginals), pseudo-ppl (Pseudo-perplexity). | masked-marginals |
| variants | 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 confident number about a protein nobody has. | |
| offset_idx | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| model | Yes | which ESM-2 export produced these scores. Scores from two models are not comparable |
| passes | Yes | forward passes the run cost — the price of the strategy, after the fact |
| ranked | Yes | just the substitution notations, in the same order — the list to take forward into an order or a filter |
| scores | Yes | every variant with its score in nats, the strategy that produced it and the forward passes it cost — MOST DAMAGING FIRST, which is the reason to rank a library at all |
| caption | Yes | the one sentence a score may never be shown without, generated from THIS run rather than fixed: what the number means under the strategy that produced it, and what it is not |
| strategy | Yes | which of the three strategies ran. Scores from two strategies are not comparable either, and pseudo-perplexity is not even the same quantity |
| mostDamaging | Yes | the lowest-scoring substitution. It is the model's opinion about likelihood, not a measured loss of function, and `caption` is the sentence that says so |
| variantCount | Yes | how many substitutions were scored |
| leastDamaging | Yes | the highest-scoring substitution — the one the model finds most ordinary |
screen_contaminationARead-onlyInspect
Screen a nucleotide sequence for vector, adapter, linker and primer contamination against NCBI's UniVec, using VecScreen's own BLASTn parameters and category rules.
| Name | Required | Description | Default |
|---|---|---|---|
| dust | 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 not truncated. Advanced. | |
| build | 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. | core |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| reward | 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 | 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's published VecScreen setting; changing it means the result is no longer VecScreen's. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| gap_open | 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. | |
| sequence | No | the nucleotide sequence to screen; leave empty to screen the open record. A protein sequence is refused — this is a nucleotide search. | |
| min_score | 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 longer VecScreen's. Advanced. | |
| word_size | 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 no longer VecScreen's. Advanced. | |
| gap_extend | No | cost per gapped base (`-gapextend`). Default is NCBI's published VecScreen setting; changing it means the result is no longer VecScreen's. Advanced. | |
| internal_weak | 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 evidence than a terminal one. Each ladder must stay in order (strong >= moderate >= weak) or the lower rungs become unreachable, and the run is refused rather than graded. Advanced. | |
| terminal_weak | 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 become unreachable, and the run is refused rather than graded. Advanced. | |
| x_drop_gapped | 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 is no longer VecScreen's. Advanced. | |
| internal_strong | 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 run is refused rather than graded. Advanced. | |
| terminal_strong | 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 evidence than an internal one, which is why the two ladders differ. Each ladder must stay in order (strong >= moderate >= weak) or the lower rungs become unreachable, and the run is refused rather than graded. Advanced. | |
| ungapped_cutoff | 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 VecScreen's. Advanced. | |
| x_drop_ungapped | 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 longer VecScreen's. Advanced. | |
| internal_moderate | 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 graded. Advanced. | |
| terminal_distance | 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. | |
| terminal_moderate | 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 graded. Advanced. | |
| suspect_origin_max | No | length under which a stretch of non-vector sequence stranded between two matches (or between a match and an end) is reported as 'suspect origin' — too short to have come from anywhere trustworthy, so NCBI asks for it to be removed with the vector. Advanced. | |
| x_drop_gapped_final | 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 VecScreen's. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| worst | Yes | the highest category present — strong | moderate | weak | suspect — or 'clean' when nothing was found. The slot to branch a pipeline on |
| matches | Yes | every raw match, one per database record: coordinates, strand, score and the UniVec entry hit |
| segments | Yes | the merged contaminated regions, each with its coordinates and category — what the map draws |
| cleanSequence | Yes | the longest stretch carrying no match at all — wire it onward when the screen is a trimming step rather than a gate. Empty when nothing clean is left |
| maskedSequence | Yes | the query with every match and suspect-origin stretch replaced by N — the form NCBI asks a submitter to upload |
| contaminatedPct | Yes | percentage of the query covered by at least one reported match — the slot to gate on numerically |
screen_guidesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| gg | 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 | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| spacers | Yes | the protospacers to screen (20 nt for SpCas9) — wire `topSpacer` or the spacers out of a design run, or list them. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| backbone | 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)). | original |
Output Schema
| Name | Required | Description |
|---|---|---|
| clean | Yes | the spacers that passed the GC gate and flagged no hairpin — the ones to take forward |
| counts | Yes | upstream's own four summary counts: total, after the GC screen, with a self hairpin, with a backbone hairpin |
| screened | Yes | per spacer: GC, whether it was dropped by the GC gate, the two hairpin verdicts, and every flagged 4-mer with its position |
| backboneLabel | Yes | which backbone the run screened against |
screen_molecule_libraryBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| bins | No | how many bins. | |
| rules | No | which drug-likeness rules to screen, by id. Every rule by default. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| property | 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)), lipinskiHba (Lipinski acceptors (N + O)), hbonds (Donors + acceptors), tpsa (TPSA (N and O only)), rotatableBonds (Rotatable bonds), rings (Rings), heavyAtoms (Heavy atoms), numAtoms (Atoms in the graph), molarRefractivity (Molar refractivity (Crippen)), averageMw (Molecular weight (average)), totalAtoms (Atoms, hydrogens included), formalCharge (Net formal charge). | mw |
| molecules | Yes | the library: one SMILES or molfile per entry. | |
| alert_sets | No | which structural-alert catalogs to screen against. Empty screens nothing. | |
| split_rule | 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_four (Rule of four (PPI inhibitors)), rule_of_three (Rule of three (fragments)), rule_of_three_extended (Rule of three, extended), rule_of_two (Rule of two (building blocks)), rule_of_ghose (Ghose filter), rule_of_veber (Veber filter), rule_of_reos (REOS), rule_of_chemaxon_druglikeness (ChemAxon drug-likeness), rule_of_egan (Egan filter), rule_of_pfizer_3_75 (Pfizer 3/75), rule_of_gsk_4_400 (GSK 4/400), rule_of_oprea (Oprea lead-likeness), rule_of_xu (Xu drug-like index), rule_of_cns (CNS penetration), rule_of_respiratory (Respiratory (inhaled/nasal)), rule_of_five_paper (Lipinski rule of five (paper: average MW)), rule_of_ghose_paper (Ghose filter (paper: all atoms, average MW)), rule_of_reos_paper (REOS (paper: net charge bounded, average MW)). |
Output Schema
| Name | Required | Description |
|---|---|---|
| rows | Yes | per structure: 0-based index, canonical SMILES, rules broken, alerts tripped |
| summary | Yes | how many structures pass clean, and how many fall within the split bound |
| distribution | Yes | the bins (lo, hi, within, outside), the bounds on the property and the split |
screen_oligo_structureARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| names | No | optional labels, in the same order as `oligos` — what the pair table calls each one. Missing or short, the rest are numbered. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| oligos | 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. | |
| dv_conc | No | divalent cations (Mg²⁺), mM. In mM. | |
| mv_conc | No | monovalent cations (Na⁺ + K⁺ + Tris⁺), mM. In mM. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| dna_conc | No | oligo strand concentration, nM — it moves a DIMER's Tm and leaves a hairpin's alone, because a hairpin is unimolecular. In nM. | |
| max_loop | No | largest internal loop the alignment will span (primer3's MAX_LOOP). Advanced. | |
| dntp_conc | No | total dNTPs, mM — subtracted from the divalent term, because dNTPs chelate Mg²⁺. In mM. | |
| temperature | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| clean | Yes | the oligos that broke no limit of their own AND appear in no flagged pair — the ones to order. An oligo is dropped from here for a partner's sake, which is the point of screening a POOL |
| pairs | Yes | every unordered pair INCLUDING the self diagonal, with the any-position and 3'-end cross-dimer and which oligo's 3' end the reported end measure belongs to |
| limits | Yes | the five primer3 cutoffs every verdict here was made against, and the settings file they come from — a verdict whose threshold is not stated is not checkable (§10a) |
| flagged | Yes | only the oligos and pairs that broke a limit, with which limit — the list to act on. Empty is a real result and means every measure sat under primer3's cutoffs |
| perOligo | Yes | per oligo: its hairpin, its self-dimer anywhere and its 3'-end self-dimer, each with ΔG, ΔH, ΔS, Tm, the limit it was graded against and whether it exceeds it — plus primer3's own drawing of the pairing, so a number can be checked rather than trusted |
| conditions | Yes | the buffer every number here was computed in, including the values left at their default — so a result carries its own reaction rather than an unstated one |
| provenance | Yes | which primer3 this engine IS, and which one a user comparing against primer3web or bioconda `ntthal` is holding. The two generations disagree on about 3% of primer-length oligos |
| worstAnyTmC | Yes | the highest any-position dimer melting temperature in the set, self-dimers included |
| worstEndTmC | Yes | the highest 3'-end dimer melting temperature in the set — the single number that predicts a primer-dimer band. Self-dimers count, because an oligo dimerising with itself makes a band too. 0 means no 3'-anchored alignment was found at all, not that the set is safe |
| worstHairpinTmC | Yes | the highest hairpin melting temperature across the oligos — a hairpin melting above the annealing temperature competes with the template |
| incompatibleCount | Yes | how many DISTINCT pairs broke a limit — the self diagonal excluded, because a single oligo's self-dimer is not a pair problem and counting it makes a one-oligo run report an incompatibility. Branch a workflow on this rather than re-deriving it from `pairs`; read `flagged` for the self-structures |
scrub_restriction_sitesBInspect
Propose the minimal SILENT synonymous edits that remove forbidden restriction sites from a CDS (a design/write).
| Name | Required | Description | Default |
|---|---|---|---|
| dna | Yes | the CDS nucleotide sequence (in frame). | |
| table | 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 from one someone built or fetched. Leave unset and the active table is used. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| protein | Yes | the CDS translation (for silence checking). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| table_tsv | 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 a typed one is indistinguishable from a real one in the result. TSV: codon<TAB>count. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| dna | Yes | the scrubbed CDS (silent edits applied) |
| fixes | Yes | one entry per synonymous swap made |
| fixCount | Yes | number of codons changed |
search_literatureARead-onlyInspect
Search the published literature: PubMed, Europe PMC (including open-access full-text sections), OpenAlex, Crossref, arXiv, bioRxiv/medRxiv preprints or DataCite datasets.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | maximum records (1–20). | |
| query | Yes | search terms, or a command such as "pmid:35486828", "fulltext:PMC9046468" or "openalex_search_works:CRISPR". | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| source | Yes | which authority to ask. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | how many records came back, which is a result even when it is zero |
| records | Yes | the records the authority returned, in its own field names — wire them into a tool that takes ids, or read them in the transcript |
| envelope | Yes | the authority's whole answer: paging, totals and the query it actually ran |
| provenance | Yes | the authority, the exact endpoints called and when — what makes an answer re-checkable without re-running it |
search_molecule_libraryARead-onlyInspect
Which of a list of small molecules contain a SMARTS substructure, with RDKit's substructure library (pattern-fingerprint screen, then atom matching).
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| smarts | Yes | the substructure, as SMARTS (a plain SMILES reads as one). | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| molecules | Yes | the library: one SMILES or molfile per entry. |
Output Schema
| Name | Required | Description |
|---|---|---|
| hits | Yes | 0-based indices of the molecules that contain the pattern, ascending |
| unread | Yes | 0-based indices of the entries RDKit could not read, never searched |
| summary | Yes | how many structures contain the pattern, of how many searched |
search_off_targetsBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | cap the rows returned (hits come back worst-first: fewest mismatches). 0 = all. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| spacer | Yes | the protospacer to search for (20 nt for SpCas9). | |
| subject | No | the sequence to search — wire a record or name a library document; leave unset to search the open record. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| circular | No | search across the origin as well. Advanced. | |
| nuclease | 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 (3')), SaCas9-KKH (SaCas9-KKH: NNNRRT (3')), AsCas12a (AsCas12a: TTTV (5')), LbCas12a (LbCas12a: TTTV (5')), enAsCas12a (enAsCas12a: TTTV (5')). | SpCas9 |
| dna_bulge | 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 `validated: false` for itself. In nt. Advanced. | |
| rna_bulge | No | extra bases in the guide a site may carry (a gap opened in the DNA). Same envelope as `dna_bulge`. In nt. Advanced. | |
| max_mismatches | No | how many mismatches a site may carry and still be reported. |
Output Schema
| Name | Required | Description |
|---|---|---|
| hits | Yes | each candidate site: position, strand, mismatches, the PAM found, and its MIT/CFD scores |
| total | Yes | sites found before `limit` was applied |
| scored | Yes | false when this nuclease has no published MIT/CFD model — the hits are still real, the scores are absent |
| byMismatch | Yes | how many sites carry 0, 1, 2 … mismatches — the census a specificity read needs |
| cfdSpecificity | Yes | aggregate CFD specificity within the searched sequence, 0-100: the same Hsu-form aggregate over each site's CFD score (null when the nuclease geometry is unscored) |
| mitSpecificity | Yes | aggregate MIT specificity within the searched sequence, 0-100 (null when the nuclease geometry is unscored) |
search_recordsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | how many hits to ask each source for. The panel pages at this size, and every source is asked for the same number. | |
| query | 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". | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| sources | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| hits | Yes | the full result rows: accession, title, source, organism, length, molecule kind and the archive’s own reported fields |
| source | Yes | which archive the top hit came from, ready for the same node's $source where the two vocabularies agree |
| hitCount | Yes | how many records came back across every source asked |
| accession | Yes | the top hit's accession, ready for a fetch_record node's $accession. This is the seam between searching and fetching |
| accessions | Yes | every hit’s accession, newline-separated, in the order they are ranked |
| unavailable | Yes | the sources that could not answer, each with the reason: empty when every source answered. A search is not a failure because one archive is down, and hiding that would make a short list read as a small literature |
select_substitution_modelARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| models | No | candidate substitution models. Every one is fitted; the sweep costs one ML optimisation per candidate. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| criterion | No | which information criterion ranks the table. Changing it re-ranks candidates that are already fitted — it does not re-fit them. | AIC |
| sequences | Yes | aligned sequences — wire align_sequences' rows here, or name library documents. | |
| include_subject | No | also include the node's subject. | |
| gamma_categories | 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 | No | also try each model with a proportion of invariant sites (+I), doubling the candidate count. |
Output Schema
| Name | Required | Description |
|---|---|---|
| best | Yes | the winning model in the conventional shorthand (e.g. `GTR+G4+I`) |
| fits | Yes | every candidate with its log-likelihood, free parameters, AIC/AICc/BIC and Akaike weight |
| weight | Yes | the winner's Akaike weight — the share of the evidence it carries. A low weight means the data do not choose between the top models, which is a finding and not a failure |
| candidates | Yes | how many candidates were fitted |
| startingTree | Yes | the ONE topology every candidate was fitted on, in Newick — reported because it is a shared assumption of the whole table |
simulate_rnaseq_powerBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | the seed; round i uses seed + i, as PROPER does. Advanced. | |
| genes | No | genes in the simulated experiment. | |
| pilot | 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 dispersion)), gilad (Gilad (human liver, moderate)), bottomly (Bottomly (inbred mice, small)), maqc (MAQC (technical replicates)), depth (Sequencing depth), constant (One constant). | cheung |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| cutoff | No | the cut-off a gene is called at. | |
| rounds | No | simulated experiments. PROPER's own default is 100; each is a full edgeR run at every sample size, so time grows with it. | |
| strata | No | stratum break points; unset, PROPER's: 0, 10, 20, 40 … 1280, ∞ for expression. Advanced. | |
| target | 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). | lfc |
| call_by | No | call a gene by its FDR or its raw p-value. Values: fdr (FDR), pval (raw p-value). | fdr |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| log_mean | No | the natural-log mean count every gene shares. Only applies when pilot is constant. | |
| filter_by | 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. | none |
| threshold | No | the threshold a DE gene's size must exceed to count. | |
| dispersion | No | one dispersion (BCV²) for every gene, instead of the pilot's; left unset, the pilot's own. Advanced. | |
| replicates | No | replicates per group at each sample size to evaluate. | |
| stratify_by | No | stratify the power by expression (mean normalized count) or by dispersion. Values: expr (Expression), dispersion (Dispersion). Advanced. | expr |
| second_group | No | replicates in the second group at each size, when the groups differ. Advanced. | |
| depth_factors | No | sequencing depth multipliers to re-weight power to. Advanced. | |
| dropped_strata | No | which strata (1-based) to drop. Only applies when filter_by is expr. Advanced. | |
| log_fold_change | No | one log fold change for every DE gene; left unset, PROPER's normal(0, 1.5) draws. Advanced. | |
| changed_fraction | No | the proportion of genes that are differentially expressed. | |
| dispersion_pilot | No | take dispersions from this pilot instead (with a depth or a constant baseline, Cheung's unless set). Advanced. | |
| reads_per_sample | No | total reads per sample. Only applies when pilot is depth. |
Output Schema
| Name | Required | Description |
|---|---|---|
| power | Yes | marginal power at each sample size |
| strata | Yes | the stratum intervals the stratified readouts are over |
| powerSE | Yes | the Monte-Carlo standard error of each marginal power |
| rScript | Yes | the R that reproduces the run |
| summary | Yes | per sample size: nominal and achieved FDR (or type I error), marginal power, mean true and false discoveries, false discovery cost |
| seqDepth | Yes | marginal power re-weighted to each sequencing depth factor, per sample size |
| stratifiedFDR | Yes | achieved FDR by stratum and sample size |
| stratifiedPower | Yes | power by expression (or dispersion) stratum, one line per sample size |
simulate_taqman_curveARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| beta | No | stretching exponent of the decay, exp(-(k_deg*t)^beta). Upstream ships 1, which makes the decay a plain exponential. Advanced. | |
| k_deg | 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 the model upstream ships; raise it and the plateau bends down. Advanced. | |
| probe | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| cycles | No | how many cycles to run. In cycles. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| amplicon | 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 late in the run, which is what bends the plateau. | |
| probe_molar | 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. | |
| annealing_time | 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. | |
| forward_primer | Yes | forward primer, 5'->3'. | |
| reverse_primer | Yes | reverse primer, 5'->3'. | |
| primer_dimer_dg | 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 nonspecific binding of P_for and P_rev into PD is not in perfect match', so nearest-neighbour formulas are the wrong class of tool. primer3's `thal`, which this repo does ship, is that class: on upstream's own C22 assay it returns -4.40 against upstream's -8.880. Pass the `thal` figure if it is the best you have and treat the answer as carrying that estimator's name, or pass a NUPACK value to reproduce the paper. In kcal/mol. | |
| template_copies | 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. | |
| denaturation_time | 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. | |
| forward_primer_molar | No | forward primer concentration, mol/L (450 nM in upstream's assay). In M. Advanced. | |
| reverse_primer_molar | No | reverse primer concentration, mol/L (460 nM in upstream's assay). In M. Advanced. | |
| annealing_temperature | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| cq | Yes | the predicted Cq, as a whole cycle number - upstream reads it as the cycle maximising the curve's SECOND derivative, so it is not interpolated and never fractional |
| notes | Yes | what the run wants said about itself, in the panel's own words |
| plateau | Yes | the final cycle's reading - what the curve levels off at, capped by the probe you put in |
| curvePlot | Yes | the predicted amplification curve as a plot, one point per cycle |
| estimators | Yes | which model produced each quoted quantity, so nothing here is read as upstream's when it is ours (§10 r11) |
| fluorescence | Yes | the predicted curve: one reading per cycle, in mol/L of cleaved probe |
| probeConsumed | Yes | fraction of the probe cleaved by the last cycle. Near 1 the plateau is probe-limited and the Cq is still trustworthy; well under it something else stopped the reaction |
size_fragmentsBRead-onlyInspect
Size the peaks of a fragment-analysis run (.fsa / .hid) against its own size standard, and hand them on as lengths in bases.
| Name | Required | Description | Default |
|---|---|---|---|
| kit | 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 only), file (A kit definition in this project), cordisplus (COrDIS Plus), cofiler (Cofiler), geneprint10 (GenePrint 10), globalfiler (GlobalFiler), identifilerlessils250 (Identifiler Less ILS250), identifilerpluslessils250 (IdentifilerPlus Less ILS250), identifilerplus (IdentifilerPlus), identifiler (Identifiler), microreaderyprime (Microreader Y Prime), minifiler (Minifiler), ngmselect (NGMSElect), ngm (NGM), niddkfragilex1 (NIDDKFragileX1), netbioflexplex (NetBio_FlexPlex), ppfusion6c (PowerPlex Fusion 6C), ppfusion-v2-6 (PowerPlex Fusion (v2.6)), ppfusion (PowerPlex Fusion), ppgeneprint24 (PowerPlex GenePrint24), pplexy23-v2-6 (PowerPlex Y23 (v2.6)), pplexy23 (PowerPlex Y23), powerplex1-2 (PowerPlex 1.2), powerplex16 (PowerPlex 16), powerplex18d-v2-6 (PowerPlex 18D (v2.6)), powerplex18d (PowerPlex 18D), powerplex21-v2-6 (PowerPlex 21 (v2.6)), powerplex21 (PowerPlex 21), powerplexs5 (PowerPlexS5), powerplexy (PowerPlex Y), powerplex-esi16-v2-6 (PowerPlex ESI16 (v2.6)), powerplex-esi16 (PowerPlex ESI16), powerplex-esi17-v2-6 (PowerPlex ESI17 (v2.6)), powerplex-esi17 (PowerPlex ESI17), powerplex-esx16-v2-6 (PowerPlex ESX16 (v2.6)), powerplex-esx16 (PowerPlex ESX16), powerplex-esx17-v2-6 (PowerPlex ESX17 (v2.6)), powerplex-esx17 (PowerPlex ESX17), profilerplus (ProfilerPlus), q-investigator24plex (QiagenInvestigator24plex), q-investigatorargusx12 (QiagenArgusX12), q-investigatorargusx12-qs (QiagenArgusX12_QS), ryanclarkecannabis (Cannabis), sefilerplus (SEfilerPlus), sgmplus (SGM Plus), yfilerplus (Yfiler Plus), yfiler (Yfiler), iplexstrliz500less250 (iPLEXSTRLIZ500less250), iplexstr (iPLEXSTR). | none |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| method | 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 anomalously. Applied Biosystems, DNA Fragment Analysis by Capillary Electrophoresis, Ch. 5. Values: local-southern (Local Southern), global-southern (Global Southern), least-squares-2 (Least squares (2nd order)), least-squares-3 (Least squares (3rd order)), cubic-spline (Cubic spline). | local-southern |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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. | |
| kit_file | 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 empty when the project holds exactly one, it is used. Only read when `kit` is `file`. Only applies when kit is file. | |
| max_size | No | ignore peaks sized above this. In bases. | |
| min_size | No | ignore peaks sized below this. In bases. | |
| threshold | No | minimum peak height, in the channel's own units. | |
| ladder_dye | 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 it ran in. Advanced. | |
| ladder_run | 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 own reference run, and yours reads them systematically long or short by length — measured on the bundled pairs, a ladder sits 0.27 bases from nominal at 175-200 and 1.40 at 300-325, and the sample beside it is off by the same amount, so comparing the two cancels what comparing to the table does not. Graded on the published 9947A profile over four kits: 24 of 42 loci exact against nominal, 35 of 44 against the ladder. A locus whose ladder does not produce all its declared alleles keeps its nominal sizes and says so rather than being labeled partly. Only applies when kit is file or cordisplus or cofiler or geneprint10 or globalfiler or identifilerlessils250 or identifilerpluslessils250 or identifilerplus or identifiler or microreaderyprime or minifiler or ngmselect or ngm or niddkfragilex1 or netbioflexplex or ppfusion6c or ppfusion-v2-6 or ppfusion or ppgeneprint24 or pplexy23-v2-6 or pplexy23 or powerplex1-2 or powerplex16 or powerplex18d-v2-6 or powerplex18d or powerplex21-v2-6 or powerplex21 or powerplexs5 or powerplexy or powerplex-esi16-v2-6 or powerplex-esi16 or powerplex-esi17-v2-6 or powerplex-esi17 or powerplex-esx16-v2-6 or powerplex-esx16 or powerplex-esx17-v2-6 or powerplex-esx17 or profilerplus or q-investigator24plex or q-investigatorargusx12 or q-investigatorargusx12-qs or ryanclarkecannabis or sefilerplus or sgmplus or yfilerplus or yfiler or iplexstrliz500less250 or iplexstr. | |
| lane_standard | 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 the ruler has to be named because it was never written down. A `.fsa` carries its own table, which is a measurement of that run and always wins. NCBI OSIRIS's library, 133 standards across 24 families. | |
| allele_tolerance | 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. In bases. Only applies when kit is file or cordisplus or cofiler or geneprint10 or globalfiler or identifilerlessils250 or identifilerpluslessils250 or identifilerplus or identifiler or microreaderyprime or minifiler or ngmselect or ngm or niddkfragilex1 or netbioflexplex or ppfusion6c or ppfusion-v2-6 or ppfusion or ppgeneprint24 or pplexy23-v2-6 or pplexy23 or powerplex1-2 or powerplex16 or powerplex18d-v2-6 or powerplex18d or powerplex21-v2-6 or powerplex21 or powerplexs5 or powerplexy or powerplex-esi16-v2-6 or powerplex-esi16 or powerplex-esi17-v2-6 or powerplex-esi17 or powerplex-esx16-v2-6 or powerplex-esx16 or powerplex-esx17-v2-6 or powerplex-esx17 or profilerplus or q-investigator24plex or q-investigatorargusx12 or q-investigatorargusx12-qs or ryanclarkecannabis or sefilerplus or sgmplus or yfilerplus or yfiler or iplexstrliz500less250 or iplexstr. Advanced. | |
| min_peak_spacing | 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 reports every maximum the detector finds. In bases. Advanced. | |
| pullup_threshold | 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 NCBI OSIRIS (0.2 for most kits; off where OSIRIS publishes none). 0 disables it. Only applies when kit is file or cordisplus or cofiler or geneprint10 or globalfiler or identifilerlessils250 or identifilerpluslessils250 or identifilerplus or identifiler or microreaderyprime or minifiler or ngmselect or ngm or niddkfragilex1 or netbioflexplex or ppfusion6c or ppfusion-v2-6 or ppfusion or ppgeneprint24 or pplexy23-v2-6 or pplexy23 or powerplex1-2 or powerplex16 or powerplex18d-v2-6 or powerplex18d or powerplex21-v2-6 or powerplex21 or powerplexs5 or powerplexy or powerplex-esi16-v2-6 or powerplex-esi16 or powerplex-esi17-v2-6 or powerplex-esi17 or powerplex-esx16-v2-6 or powerplex-esx16 or powerplex-esx17-v2-6 or powerplex-esx17 or profilerplus or q-investigator24plex or q-investigatorargusx12 or q-investigatorargusx12-qs or ryanclarkecannabis or sefilerplus or sgmplus or yfilerplus or yfiler or iplexstrliz500less250 or iplexstr. Advanced. | |
| stutter_threshold | 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 applies when kit is file or cordisplus or cofiler or geneprint10 or globalfiler or identifilerlessils250 or identifilerpluslessils250 or identifilerplus or identifiler or microreaderyprime or minifiler or ngmselect or ngm or niddkfragilex1 or netbioflexplex or ppfusion6c or ppfusion-v2-6 or ppfusion or ppgeneprint24 or pplexy23-v2-6 or pplexy23 or powerplex1-2 or powerplex16 or powerplex18d-v2-6 or powerplex18d or powerplex21-v2-6 or powerplex21 or powerplexs5 or powerplexy or powerplex-esi16-v2-6 or powerplex-esi16 or powerplex-esi17-v2-6 or powerplex-esi17 or powerplex-esx16-v2-6 or powerplex-esx16 or powerplex-esx17-v2-6 or powerplex-esx17 or profilerplus or q-investigator24plex or q-investigatorargusx12 or q-investigatorargusx12-qs or ryanclarkecannabis or sefilerplus or sgmplus or yfilerplus or yfiler or iplexstrliz500less250 or iplexstr. Advanced. | |
| require_resolvable | 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-standard fragment withheld, which is harsher than sizing a peak with all of them present, so in a sparsely anchored region it is pessimistic. On a run whose standard has a wide gap it is what stops a confident wrong allele; on an evenly anchored one it changes nothing. Every call carries the number either way. | |
| adenylation_threshold | 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 AdenylationThreshold default. 0 calls every peak. Only applies when kit is file or cordisplus or cofiler or geneprint10 or globalfiler or identifilerlessils250 or identifilerpluslessils250 or identifilerplus or identifiler or microreaderyprime or minifiler or ngmselect or ngm or niddkfragilex1 or netbioflexplex or ppfusion6c or ppfusion-v2-6 or ppfusion or ppgeneprint24 or pplexy23-v2-6 or pplexy23 or powerplex1-2 or powerplex16 or powerplex18d-v2-6 or powerplex18d or powerplex21-v2-6 or powerplex21 or powerplexs5 or powerplexy or powerplex-esi16-v2-6 or powerplex-esi16 or powerplex-esi17-v2-6 or powerplex-esi17 or powerplex-esx16-v2-6 or powerplex-esx16 or powerplex-esx17-v2-6 or powerplex-esx17 or profilerplus or q-investigator24plex or q-investigatorargusx12 or q-investigatorargusx12-qs or ryanclarkecannabis or sefilerplus or sgmplus or yfilerplus or yfiler or iplexstrliz500less250 or iplexstr. Advanced. | |
| include_ladder_channel | No | also report the size standard's own peaks. They are the ruler, so they are excluded by default. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| run | Yes | what the FILE says about itself: sample, instrument, polymer, dye names, scan count. Not the channels, which cannot ride a wire |
| peaks | Yes | every sized peak: size in bases, dye, height, scan, and whether it saturated |
| sizes | Yes | just the lengths in bases, ascending — the list a downstream gate reads |
| alleles | Yes | each peak's locus and allele under the chosen kit, with the ones that could not be named and WHY. Null when no kit was named |
| accuracy | Yes | this run's own sizing error in bases, measured by leaving each standard fragment out and sizing it from the others. A difference smaller than this is not one the run can resolve |
| genotype | Yes | the alleles called per locus — the readout a downstream step compares. Null when no kit was named |
| peakCount | Yes | how many peaks were sized |
| sizeStandard | Yes | the ladder the sizes rest on: its fragments, the channel it was found in, and how that channel was chosen |
| lane_standard_fit | Yes | how a NAMED lane standard was fitted, when one was used: the peaks it matched, the correlation it reached and the threshold that had to be cleared, so a caller can see why the sizes are trusted. Null for a run whose file records its own standard |
| ladder_calibration | Yes | when a ladder run was named: which loci it labeled, at what spacing correlation, which it refused and why, and how many alleles were re-expressed in this instrument's own sizes. Null when the kit's nominal sizes were used |
solve_dilutionBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| final_volume | No | final volume (V₂). Leave exactly one of the four quantities empty: that one is calculated. | |
| stock_volume | No | stock volume (V₁). Leave exactly one of the four quantities empty: that one is calculated. | |
| final_volume_unit | No | the unit of the final volume, given or solved. | mL |
| stock_volume_unit | No | the unit of the stock volume, given or solved. | µL |
| final_concentration | No | final concentration (C₂). Leave exactly one of the four quantities empty: that one is calculated. | |
| stock_concentration | No | stock concentration (C₁). Leave exactly one of the four quantities empty: that one is calculated. | |
| final_concentration_unit | No | the unit of the final concentration, given or solved. | µM |
| stock_concentration_unit | No | the unit of the stock concentration, given or solved. | mM |
Output Schema
| Name | Required | Description |
|---|---|---|
| fold | Yes | C₁/C₂, how many times the stock is diluted |
| unit | Yes | the solved quantity's unit |
| value | Yes | the solved quantity, in its own unit |
| solved | Yes | which quantity was solved, by its parameter name |
| diluent | Yes | V₂ − V₁, the diluent to add, in V₂'s unit |
summarize_rowsBRead-onlyInspect
Reduce a whole TABLE column to one number — the largest band, the median guide score, the spread of a set of melting temperatures.
| Name | Required | Description | Default |
|---|---|---|---|
| trim | 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. | |
| field | 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. | |
| items | Yes | the rows to summarize. Wire a json/list output (bands, guides, assays, amplicons). | |
| label | No | what this summary IS, in your words. It becomes the message the run reports. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| operation | 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: sum (sum), min (minimum), max (maximum), absmin (smallest by magnitude), absmax (largest by magnitude), range (range (max − min)), count (count of values), first (first value), last (last value), mode (most common value), antimode (least common value), unique (the distinct values, sorted), collapse (every value, in order), countunique (count of distinct values), mean (mean), geomean (geometric mean), harmmean (harmonic mean), trimmean (trimmed mean), median (median), q1 (lower quartile), q3 (upper quartile), iqr (interquartile range), perc (percentile), pstdev (standard deviation (population)), sstdev (standard deviation (sample)), pvar (variance (population)), svar (variance (sample)), ms (mean square), rms (root mean square), mad (median absolute deviation, scaled), madraw (median absolute deviation, unscaled), sskew (skewness (sample)), pskew (skewness (population)), skurt (excess kurtosis (sample)), pkurt (excess kurtosis (population)), jarque (Jarque–Bera normality p-value), dpo (D'Agostino–Pearson normality p-value), scov (covariance (sample)), pcov (covariance (population)), spearson (Pearson correlation (sample)), ppearson (Pearson correlation (population)). | max |
| percentile | No | which percentile to take, 0–100. In %. Only applies when operation is perc. | |
| group_field | 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 | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| used | Yes | how many of those rows actually carried a number. Lower than `count` means the column has gaps, and the summary says so rather than implying it read them all |
| count | Yes | how many rows went into it: a summary of three bands and a summary of thirty are different claims |
| value | Yes | the summary itself. Wire it into a gate's `value` or its `against`; with a `group_field` this is the first group's value, and `groups` is the table you want |
| groups | Yes | one row per group (`{ group, value, count, used }`) when a `group_field` is set. Wire it into `check_rows` to gate every group at once |
| number | Yes | the same answer as a number, so it can drive a numeric port directly. Absent for the text summaries (`first`, `unique`, …) |
| message | Yes | what was summarized, in words |
| groupCount | Yes | how many distinct groups the split found. Absent when nothing was grouped — an ungrouped summary has no group count, and a 0 would read as one |
survey_off_targetsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| spacers | Yes | the protospacers to count — wire the spacers out of a design run, or list them. | |
| subject | No | the sequence to search — wire a record or name a library document; leave unset to search the open record. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| circular | No | count across the origin as well. Advanced. | |
| nuclease | 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 (3')), SaCas9-KKH (SaCas9-KKH: NNNRRT (3')), AsCas12a (AsCas12a: TTTV (5')), LbCas12a (LbCas12a: TTTV (5')), enAsCas12a (enAsCas12a: TTTV (5')). | SpCas9 |
| dna_bulge | No | extra bases in the DNA a site may carry. 0 counts mismatches only. In nt. Advanced. | |
| rna_bulge | No | extra bases in the guide a site may carry. Same envelope as `dna_bulge`. In nt. Advanced. | |
| max_mismatches | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| counted | Yes | how many distinct spacers were counted |
| skipped | Yes | spacers that could not be counted, each with the reason — never dropped in silence |
| spacers | Yes | one row per spacer: its counts by mismatch class, its total, its off-target count and its aggregate MIT/CFD specificity within the searched sequence |
| cleanest | Yes | the spacer with the fewest off-target sites (ties broken by the higher CFD specificity) — empty when nothing could be counted |
| searched | Yes | the sequence the counts are against, which is what makes them readable later |
target_decoy_qvaluesARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| ratio | No | decoy-to-target database size ratio. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| scores | Yes | one score per match. | |
| formula | No | 1: decoys / targets. 2: (decoys + estimated false targets) / all matches. | |
| isDecoy | Yes | one flag per match: true when it is a decoy hit. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| threshold | No | q-value cut-off for the accepted count. | |
| correction | No | 0 none; 1 the +1 correction; 2 finite-sample expectation; a value in (0, 1) is a confidence level. | |
| higherIsBetter | No | true for scores like HyperScore; false for e-values and PEPs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| q | Yes | q-value per match, in input order |
| fdr | Yes | FDR of the whole set |
| decoys | Yes | how many decoy matches were scored; the FDR estimate stands on this count |
| targets | Yes | how many target matches were scored |
| accepted | Yes | target matches at or under the q-value threshold |
| threshold | Yes | the q-value cut-off `accepted` was counted at |
tide_quantify_indelsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| guide | 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-prime of the PAM. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| edited | Yes | the EDITED trace, by file name or id. | |
| control | Yes | the UNEDITED trace, by file name or id — every indel class is the control trace shifted, so this read IS the model. | |
| seq_end | No | last base of the READ to use, clamped down to the shorter of the two reads if it overruns. In bp. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| max_shift | 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. | |
| seq_start | 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. | |
| window_end | No | last base of the decomposed region. 0 = as far as the shorter read allows. In bp. Advanced. | |
| p_threshold | 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 | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| indels | Yes | every modeled size from -max_shift to +max_shift with its percentage, p-value and whether it cleared the threshold — INCLUDING the classes that did not, so the spectrum has a shape and not only peaks |
| report | Yes | the whole result, including the window corrections upstream raises as warnings |
| rSquared | Yes | goodness of fit of the whole decomposition. Every percentage below is already scaled by it, so a low fit shrinks the classes rather than flagging them |
| breaksite | Yes | the base the break was placed at, three bases 5-prime of the PAM. Every window in the result is positioned against it |
| efficiency | Yes | total editing efficiency: the R-squared-scaled signal in every non-zero indel class, 0-100. Not the same quantity as an ICE score — wire them into a comparison rather than treating either as the number |
| aberrantSignal | Yes | the four means TIDE's own quality checklist is read from: control and sample, before and after the break. A sample already aberrant BEFORE the break is a sequencing problem rather than an edit, and this is the pair of numbers that says so |
| insertionBases | Yes | base composition of the +1 insertion as percentages in A, C, G, T order — the readout ICE cannot produce. Null when there is no significant +1 class, which is the common case and not an error; `insertionNote` then says why in upstream’s own words |
| significantIndels | Yes | the classes that cleared p_threshold, excluding the unmodified class — what a gate should read |
trace_raw_signalBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| baseline | Yes | per-channel median raw sample (A/C/G/T) — the offset analysis subtracts |
| rawScans | Yes | scans the instrument recorded, on its own time base |
| peakRawValue | Yes | the largest raw sample across all four channels |
| baselineSpread | Yes | highest channel baseline minus lowest. A large spread is one dye channel sitting high, which analysis removes and a raw view shows |
| droppedFromFront | Yes | scans analysis discarded off the front (dye front and primer peak). Gate on it: an unusually long discard is a run that took a long time to resolve |
transform_treeARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| taxa | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| newick | Yes | the tree to edit — wire `newick` from build_tree, or paste one. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| position | 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. | |
| ascending | No | ladderize small clades first, rather than large. Only applies when operation is ladderize. | |
| operation | 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-remove (Prune these taxa away), ladderize (Ladderize (presentation only)), collapse (Collapse weak or short branches). | reroot-midpoint |
| max_length | No | collapse any branch shorter than this (0 = do not). Only applies when operation is collapse. | |
| min_support | No | contract any branch whose support is below this (0 = do not). Only applies when operation is collapse. |
Output Schema
| Name | Required | Description |
|---|---|---|
| newick | Yes | the edited tree |
| tipCount | Yes | tips remaining — the number to check after a prune |
| statistics | Yes | statistics RE-DERIVED for the edited tree, because rerooting or pruning changes them and the previous numbers beside a changed tree would be wrong. Absent for `ladderize`, which only reorders tips and changes no statistic |
translate_sequenceARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| cds | No | strict CDS: require a length multiple of 3, a start codon and a terminal stop (errors otherwise). Advanced. | |
| table | No | NCBI genetic-code table id (1 = standard). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| feature | 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 | 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. | |
| to_stop | No | stop at the first stop codon instead of emitting the stop symbol. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| length | Yes | protein length in residues |
| region | Yes | what was translated, and on which strand |
| protein | Yes | the translated protein |
tree_statisticsARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| newick | Yes | the tree to describe — wire `newick` from build_tree, or paste one. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| ltt | Yes | lineages-through-time: the points of the curve and the coalescence times behind it |
| lttPlot | Yes | the lineages-through-time curve as a plot |
| tipCount | Yes | number of tips |
| patristic | Yes | labels and the matrix of path lengths between every pair of tips |
| statistics | Yes | tips, height, balance and the gamma statistic (with the reason when gamma is undefined for this tree) |
| patristicMap | Yes | the patristic distances as a heatmap |
tree_taxon_annotationsBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| nexml | Yes | a NeXML document (the text of a .xml tree file). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. |
Output Schema
| Name | Required | Description |
|---|---|---|
| count | Yes | annotations read |
| properties | Yes | each annotated property with its count of distinct values |
| annotations | Yes | one row per annotation: otu id, taxon label, property and value, in document order |
trim_readsBRead-onlyInspect
Trim sequencing adapters and low-quality ends off FASTQ reads before mapping, and report what was removed.
| Name | Required | Description | Default |
|---|---|---|---|
| reads | Yes | the reads to trim, as FASTQ - quality lines are required, because both halves of this need them. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| adapter | No | the adapter sequence to remove. Unset means quality trimming only. Illumina TruSeq is AGATCGGAAGAGCACACGTCTGAACTCCAGTCAC and Nextera is CTGTCTCTTATACACATCT. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| min_length | No | reads shorter than this after trimming are COUNTED as too short, not removed - this tool does not filter. 0 reports none. Advanced. | |
| min_overlap | 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. | |
| adapter_kind | 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. | three_prime |
| phred_offset | No | quality encoding: 33 for every modern FASTQ, 64 only for pre-1.8 Illumina. Advanced. | |
| max_error_rate | No | errors allowed in the adapter match, as a fraction of the overlap. cutadapt's own default. Advanced. | |
| quality_cutoff_back | 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 | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| report | Yes | what was removed and by which step: bases before and after, the two attributed counts, reads with an adapter, reads emptied and reads left too short |
| readsEmptied | Yes | reads trimmed to nothing at all - a different alarm from 'too short', because it usually means the read was all adapter |
| trimmedFastq | Yes | the trimmed reads as FASTQ, ready for `map_reads` |
| readsWithAdapter | Yes | how many reads carried the adapter - the number that says whether your insert size is shorter than your read length |
| basesRemovedByAdapter | Yes | bases removed by adapter trimming alone |
| basesRemovedByQuality | Yes | bases removed by quality trimming alone |
trim_traceBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| min_q | No | the mean Phred the window has to hold for a bound to stop walking inward. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| method | 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. | auto |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | 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. | |
| win_size | No | bases in the sliding window, when the window method runs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| reading | Yes | the same sentence the editor shows for this run, generated from it |
| sequence | Yes | the trimmed read, ready to align or verify |
| keptBases | Yes | how many bases survived. Wire it into a gate: a read trimmed to nothing is not a read |
| methodUsed | Yes | which one actually ran. `auto` and `mott` both answer `window` when the file carries no Mott record, and a pipeline that assumed otherwise trimmed on a threshold nobody chose |
| lastBaseKept | Yes | 1-based inclusive |
| firstBaseKept | Yes | 1-based inclusive, matching every trim readout in the editor |
| meanQualityKept | Yes | mean Phred over the kept interval |
| meanQualityDiscarded | Yes | mean Phred over what was cut. Read it AGAINST the kept figure: if it is not lower, the trim removed nothing bad |
validate_gene_traitARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| gene | Yes | the hypothesis gene, as its current HGNC symbol (protein-coding). | |
| alpha | No | the level the sequential test stops and decides at: supported when the product of e-values exceeds 1/α. | |
| kappa | No | κ of the p-to-e calibrator e = κ·p^(κ−1). Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| tissues | No | tissue test: GTEx tissue names where involvement implies higher expression, such as Whole Blood or Spleen. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| categories | Yes | GWAS Catalog parent categories an involved gene's associations should fall in, such as Immune system disorder. | |
| trait_genes | No | co-expression: the trait's own gene(s) as HGNC symbols, such as IL2 for IL-2 production. | |
| expression_test | 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. Values: coexpression (Co-expression with the trait's gene), tissue (Expression in named tissues). | coexpression |
Output Schema
| Name | Required | Description |
|---|---|---|
| e | Yes | the stopped product of e-values: the evidence against "G is just another gene" |
| tests | Yes | every falsification test in its registered order: what it reads, its statistic, G's value, its rank among the genes and its p, and whether it was run before the stop |
| result | Yes | the full result |
| nullRate | Yes | these settings' own Type-I rate: how many of the universe's genes, each taken as the hypothesis, the same test would support |
| supported | Yes | whether the stopped product of e-values exceeds 1/α |
validate_workflowARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| graph | 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 `scatter` (run it once per element of a list input, gathering every output into an array). | |
| _files | 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 library document a tool can name in its `sequences`/`parts`/`document` arguments (a multi-record file as `file · record`), and a tool reading a file by name (a trace, an alignment) finds it here. | |
| _subject | 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 it here or refuses by name. |
variant_call_summaryARead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| contig | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| pass_only | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| qual | Yes | min, max, median and the number of records stating no QUAL. Null when nothing stated one, which is not the same as a range of zero |
| tstv | Yes | ts, tv and ratio over every ALT, and tsFirstAlt/tvFirstAlt/ratioFirstAlt over each site’s first ALT only. Both, because bcftools reports both and a multiallelic call set makes them differ |
| counts | Yes | records, samples, and the class tallies: snps, mnps, indels, others, noAlts, multiallelicSites and multiallelicSnpSites. A site counts in every class its alleles carry, which is how bcftools counts them |
| filters | Yes | every FILTER value seen with its count, including PASS and the unfiltered (`.`) tally: the two are different states and are counted apart |
| summary | Yes | the call set in one sentence, generated from this run |
| indelPlot | Yes | sites per indel length (ALT minus REF), deletions left of zero and insertions right of it |
| per_contig | Yes | records, snps and indels per contig, over everything read |
| per_sample | Yes | bcftools' PSC section per sample: refHom, nonRefHom, hets, transitions, transversions, indels, averageDepth, singletons, hapRef, hapAlt and missing |
| not_counted | Yes | what this run could NOT count and why: `genotypesUnavailable` when the file's genotypes were not parsed (so per_sample is empty for a reason), and `badAlleleCalls` listing genotypes naming an allele their record never declares. Real bcftools stats exits on such a file rather than reporting per-sample numbers, so a non-empty list means per_sample has no bcftools counterpart to be compared against |
| indel_lengths | Yes | indel length (ALT minus REF) to the number of sites, sorted by length: bcftools' IDD section. Negative is a deletion |
| substitutions | Yes | the twelve directed substitution types with their counts |
| substitutionMap | Yes | the twelve directed substitutions as a REF by ALT grid, the Summary tab’s bars as one picture; the diagonal is empty, since a base does not substitute for itself |
variant_consequencesBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| file | 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. | |
| limit | No | how many calls to return in `calls`; the counts are always of all of them. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| offset | 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. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| reference | 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 LOCUS). | |
| min_impact | No | keep only calls whose most severe consequence is rated at least this. Unset keeps every call. | |
| up_down_stream_bp | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| calls | Yes | one row per ALT allele: chrom, pos, ref, alt, the most severe term, its IMPACT, gene, transcript, HGVS c. and p., and why it was not annotated when it was not |
| by_term | Yes | how many calls have each most-severe term, over all of them |
| summary | Yes | what the set holds, generated from the annotation |
| annotated | Yes | alleles annotated |
| annotations | Yes | every consequence of every returned call, one per transcript it reaches |
| not_annotated | Yes | alleles skipped, each with its reason in `calls` |
verify_constructBRead-onlyInspect
Compare a sequencing RESULT against the construct you designed and say what differs, where, and what it lands in.
| Name | Required | Description | Default |
|---|---|---|---|
| match | No | alignment limit `match`, as the Verify panel's own slider sets it. Advanced. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| design | 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 | Yes | what actually came back from sequencing — wire a record or name a document. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| gap_open | No | alignment limit `gapOpen`, as the Verify panel's own slider sets it. Advanced. | |
| mismatch | No | alignment limit `mismatch`, as the Verify panel's own slider sets it. Advanced. | |
| word_size | No | alignment limit `wordSize`, as the Verify panel's own slider sets it. Advanced. | |
| gap_extend | No | alignment limit `gapExtend`, as the Verify panel's own slider sets it. Advanced. | |
| band_margin | No | alignment limit `bandMargin`, as the Verify panel's own slider sets it. Advanced. | |
| min_coverage | No | alignment limit `minCoverage`, as the Verify panel's own slider sets it. Advanced. | |
| confident_coverage | No | alignment limit `confidentCoverage`, as the Verify panel's own slider sets it. Advanced. | |
| min_result_fraction | No | alignment limit `minResultFraction`, as the Verify panel's own slider sets it. Advanced. |
Output Schema
| Name | Required | Description |
|---|---|---|
| report | Yes | the whole verification, including the alignment frame and band |
| identity | Yes | positions where design and result agree, over the aligned length, as a PERCENTAGE — 100 for an exact match, not 1 |
| differences | Yes | every difference with its 1-based position on the design and a one-line description |
| largeEvents | Yes | structural events — a dropped cassette or a duplicated span reads as one event here rather than as hundreds of substitutions |
| differenceCount | Yes | substitutions, insertions and deletions found — NOT counting positions the sequencer could not call |
| affectedFeatures | Yes | features with a real difference, missing bases or uncalled positions — worst first |
| worstConsequence | Yes | the most severe consequence term any affected feature carries, by Ensembl's published ranking — the one value a gate should read |
| uncalledPositions | Yes | positions the result could not call. Counted apart from differences on purpose: an uncalled base is not a mutation, and folding the two together reports a clean read as a damaged one |
verify_readARead-onlyInspect
Grade a sequencing read against a reference (✓ verified / ⚠ near / ~ partial / ✗ divergent) from an alignment.
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| read_name | No | what to call the read in the report row. | read |
| target_len | Yes | reference length in bp. In bp. | |
| aligned_ref | Yes | gapped reference (target) row. | |
| target_name | No | what to call the reference in the report row. | reference |
| aligned_read | Yes | gapped read (query) row. | |
| near_coverage_pct | No | reference coverage required to grade a read near. In %. | |
| near_ungapped_pct | No | ungapped identity required to grade a read near — NOT the gap-inclusive `identity` output. In %. | |
| verified_max_gaps | No | gaps tolerated in a verified alignment. | |
| verified_coverage_pct | No | reference coverage required to grade a read verified. In %. | |
| verified_ungapped_pct | No | ungapped identity required to grade a read verified — NOT the gap-inclusive `identity` output. In %. |
Output Schema
| Name | Required | Description |
|---|---|---|
| report | Yes | the row that goes in the record: target, read, grade, ungapped identity, coverage, mismatches and indel events |
| result | Yes | the full alignment result (matches, mismatches, gaps, identities) |
| status | Yes | the grade: verified / near / partial / divergent |
| identity | Yes | gap-inclusive identity % (BLAST convention) |
| mismatches | Yes | mismatch count |
| coveragePct | Yes | how much of the reference the read actually covers — a perfect identity over 20% of the target is not a verified clone |
| indelEvents | Yes | insertion/deletion EVENTS, not bases — one 12 bp deletion is one event |
write_structure_libraryBRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| names | No | a name per structure, in the same order (the SDF title line, the SMILES second column). | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| format | No | the file format. Values: sdf (SDF), sdf-v3000 (SDF V3000), smiles (SMILES), cxsmiles (CXSMILES). | sdf |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| molecules | Yes | the structures: one SMILES or molfile per entry. | |
| with_properties | No | SDF only: add canonical_smiles and the RDKit descriptors to each record as data fields. |
Output Schema
| Name | Required | Description |
|---|---|---|
| text | Yes | the file |
| unread | Yes | 0-based indices of the entries RDKit could not read, left out of the file |
| summary | Yes | how many structures were written, of how many given, and which were left out |
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
7 tool updates
- Changed
analyze_flow_cytometry1 field changed- added
Input schema / properties / derivedAdded value: +{ + "default": "", + "description": "derived parameters, `name = expression` separated by `;` (FlowJo's vocabulary: channels by name or [name], + − * / % ^, abs ceil floor neg round max min pow exp ln log sqrt and the trig functions); each becomes a channel of the run.", + "type": "string" +}
- Added
auto_gate_flow_cytometry - Added
check_flow_cytometry_quality - Added
cluster_flow_cytometry_flowsom - Added
compare_flow_cytometry_populations - Added
estimate_spillover_from_controls - Added
flow_cytometry_kinetics
2 tool updates
- Added
analyze_flow_cytometry - Changed
design_ligation_independent_primers3 fields changed- changed
Input schema / properties / eklic_tag / descriptionPrevious value: -"Ek/LIC only: keep the C-terminal tag, or close the insert with the in-frame stop TB163 gives for a construct that omits it. Advanced."New value: +"Ek/LIC only: keep the C-terminal tag, or close the insert with the in-frame stop TB163 gives for a construct that omits it. Only applies when eklic is true. Advanced." - changed
Input schema / properties / user_vector / descriptionPrevious value: -"USER only: join the two outer ends to a vector that already carries fixed 3' extensions, which is how a USER construct closes a ring. pNEB206A is the vector the method's own paper uses. Values: none (None (linear chain)), pNEB206A (pNEB206A)."New value: +"USER only: join the two outer ends to a vector that already carries fixed 3' extensions, which is how a USER construct closes a ring. pNEB206A is the vector the method's own paper uses. Values: none (None (linear chain)), pNEB206A (pNEB206A). Only applies when method is user." - changed
Input schema / properties / user_vector_end / descriptionPrevious value: -"USER with a vector: which of its two DIFFERENT extensions the first fragment's forward primer matches, which is what sets the insert's orientation in the vector. Values: left (Left (GGAGACAU)), right (Right (GGGAAAGU)). Advanced."New value: +"USER with a vector: which of its two DIFFERENT extensions the first fragment's forward primer matches, which is what sets the insert's orientation in the vector. Values: left (Left (GGAGACAU)), right (Right (GGGAAAGU)). Only applies when user_vector is pNEB206A. Advanced."
1 tool update
- Added
design_ligation_independent_primers
5 tool updates
- Changed
check_index_pool1 field changed- changed
Output schema / properties / hopping / descriptionPrevious value: -"index-hopping exposure: combinations possible against combinations in use, the removable share, and the undetectable swaps"New value: +"index-hopping exposure: combinations possible against combinations in use, the removable share, and the undetectable swaps. Absent for a single-index pool, which has no i5 to swap."
- Added
describe_tools - Changed
plan_next_tools1 field changed- removed
Input schema / properties / independent_onlyRemoved value: -{ - "default": false, - "description": "keep only steps that read none of the data files the finished run read, so each adds its own evidence.", - "type": "boolean" -}
- Changed
query_database1 field changed- added
Input schema / properties / limit / defaultAdded value: +10
- Added
read_answer_window
7 tool updates
- Added
alignment_pca - Added
alignment_redundancy - Added
assemble_multiple_inserts - Added
design_combinatorial_library - Added
design_gene_fragment_order - Added
ligation_independent_clone - Added
variant_consequences
3 tool updates
- Added
convert_mass_moles - Changed
plan_master_mix9 fields changed- changed
Input schema / properties / include_dmso / descriptionPrevious value: -"include the setup's optional DMSO (3% final for Phusion). It lowers primer Tm, so lower the annealing temperature. Only applies when components is not given."New value: +"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." - added
Input schema / properties / include_q_solutionAdded value: +{ + "default": false, + "description": "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. Only applies when setup is qiagen-taq-201203 or qiagen-hotstartaq-203203.", + "type": "boolean" +} - added
Input schema / properties / mg_finalAdded value: +{ + "description": "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 HotStarTaq DNA Polymerase (203203). In mM. Only applies when setup is qiagen-taq-201203 or qiagen-hotstartaq-203203.", + "minimum": 0, + "type": "number" +} - added
Input schema / properties / primer_finalAdded value: +{ + "description": "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. Only applies when setup is takara-taq-r001a or takara-ex-taq-rr001a or takara-la-taq-rr002a or takara-ex-premier-rr370a or primestar-gxl-r050a or primestar-gxl-r050a-rapid or primestar-hs-r010a or primestar-max-r045a or primestar-longseq-r055a or cloneamp-hifi-639298 or speedstar-hs-rr070a or terra-direct-639270 or advantage-hd-639241 or qiagen-taq-201203 or qiagen-hotstartaq-203203.", + "minimum": 0, + "type": "number" +} - added
Input schema / properties / primer_stockAdded value: +{ + "default": 10, + "description": "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-taq-rr002a or takara-ex-premier-rr370a or primestar-gxl-r050a or primestar-gxl-r050a-rapid or primestar-hs-r010a or primestar-max-r045a or primestar-longseq-r055a or cloneamp-hifi-639298 or speedstar-hs-rr070a or terra-direct-639270 or advantage-hd-639241 or qiagen-taq-201203 or qiagen-hotstartaq-203203.", + "minimum": 0, + "type": "number" +} - changed
Input schema / properties / reaction_volume / descriptionPrevious value: -"volume of one reaction, µl. NEB publishes the Phusion setup at 20 and 50 µl; any volume scales from them. In µl."New value: +"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." - changed
Input schema / properties / setup / descriptionPrevious value: -"the vendor reaction setup to scale. Ignored when `components` is given. Values: neb-phusion-m0530 (Phusion High-Fidelity DNA Polymerase (M0530)). Only applies when components is not given."New value: +"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-rr001a (TaKaRa Ex Taq (RR001A)), takara-la-taq-rr002a (TaKaRa LA Taq (RR002A)), takara-ex-premier-rr370a (TaKaRa Ex Premier (RR370A)), primestar-gxl-r050a (PrimeSTAR GXL (R050A), standard protocol), primestar-gxl-r050a-rapid (PrimeSTAR GXL (R050A), rapid protocol), primestar-hs-r010a (PrimeSTAR HS (R010A)), primestar-max-r045a (PrimeSTAR Max (R045A)), primestar-longseq-r055a (PrimeSTAR LongSeq (R055S/R055A)), cloneamp-hifi-639298 (CloneAmp HiFi PCR Premix (639298)), speedstar-hs-rr070a (SpeedSTAR HS (RR070A)), terra-direct-639270 (Terra PCR Direct Polymerase Mix (639270)), titanium-taq-639208 (Titanium Taq DNA Polymerase (639208)), advantage-hd-639241 (Advantage HD Polymerase Mix (639241)), qiagen-taq-201203 (QIAGEN Taq DNA Polymerase (201203)), qiagen-hotstartaq-203203 (QIAGEN HotStarTaq DNA Polymerase (203203)). Only applies when components is not given." - changed
Input schema / properties / setup / enumPrevious value: -[ - "neb-phusion-m0530" -]New value: +[ + "neb-phusion-m0530", + "takara-taq-r001a", + "takara-ex-taq-rr001a", + "takara-la-taq-rr002a", + "takara-ex-premier-rr370a", + "primestar-gxl-r050a", + "primestar-gxl-r050a-rapid", + "primestar-hs-r010a", + "primestar-max-r045a", + "primestar-longseq-r055a", + "cloneamp-hifi-639298", + "speedstar-hs-rr070a", + "terra-direct-639270", + "titanium-taq-639208", + "advantage-hd-639241", + "qiagen-taq-201203", + "qiagen-hotstartaq-203203" +] - changed
Input schema / properties / template_volume / descriptionPrevious value: -"template DNA per reaction, µl, added to each tube rather than the mix. The vendor leaves it to you (NEB: < 250 ng). In µl. Only applies when components is not given."New value: +"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 not given."
- Added
plan_serial_dilution
4 tool updates
- Changed
check_color_balance1 field changed- changed
Output schema / properties / channelPlot / descriptionPrevious value: -"the fraction of the pool producing signal in each channel at each index cycle; the series are named after the channels, and their colours are not the dyes"New value: +"the fraction of the pool producing signal in each channel at each index cycle; the series are named after the channels, and their colors are not the dyes"
- Changed
fetch_article1 field changed- changed
Output schema / properties / license / descriptionPrevious value: -"the article's own licence statement, as the publisher wrote it"New value: +"the article's own license statement, as the publisher wrote it"
- Added
plan_master_mix - Added
solve_dilution
49 tool updates
- Changed
align_read2 fields changed- added
Output schema / properties / identity / x-unitAdded value: +"%" - added
Output schema / properties / referenceLength / x-unitAdded value: +"bp"
- Changed
analyze_melt_curves1 field changed- added
Output schema / properties / meanTm / x-unitAdded value: +"°C"
- Changed
blast_project_sequences1 field changed- added
Output schema / properties / topIdentity / x-unitAdded value: +"%"
- Changed
blast_search1 field changed- added
Output schema / properties / topIdentity / x-unitAdded value: +"%"
- Changed
call_cq1 field changed- added
Output schema / properties / meanEfficiency / x-unitAdded value: +"%"
- Changed
check_scorpion_stem3 fields changed- added
Output schema / properties / difference / x-unitAdded value: +"°C" - added
Output schema / properties / probeTm / x-unitAdded value: +"°C" - added
Output schema / properties / stemTm / x-unitAdded value: +"°C"
- Changed
codon_table_fetch1 field changed- added
Output schema / properties / gc3 / x-unitAdded value: +"%"
- Changed
compare_constructions1 field changed- added
Output schema / properties / similarity / x-unitAdded value: +"%"
- Changed
compare_reads_to_reference2 fields changed- added
Output schema / properties / coveragePct / x-unitAdded value: +"%" - added
Output schema / properties / identityPct / x-unitAdded value: +"%"
- Changed
crispr_quantify_edits1 field changed- added
Output schema / properties / hdrPct / x-unitAdded value: +"%"
- Changed
design_fusion_site_primers2 fields changed- added
Output schema / properties / forwardTm / x-unitAdded value: +"°C" - added
Output schema / properties / reverseTm / x-unitAdded value: +"°C"
- Changed
design_gibson_primers1 field changed- added
Output schema / properties / overlap / x-unitAdded value: +"bp"
- Changed
design_multisite_primers1 field changed- added
Output schema / properties / reactionTemperature / x-unitAdded value: +"°C"
- Changed
design_overhang_set1 field changed- added
Output schema / properties / percent / x-unitAdded value: +"%"
- Changed
design_primer_pairs2 fields changed- added
Output schema / properties / productLen / x-unitAdded value: +"bp" - added
Output schema / properties / ta / x-unitAdded value: +"°C"
- Changed
design_primers5 fields changed- added
Output schema / properties / forwardTm / x-unitAdded value: +"°C" - added
Output schema / properties / productLen / x-unitAdded value: +"bp" - added
Output schema / properties / productTm / x-unitAdded value: +"°C" - added
Output schema / properties / reverseTm / x-unitAdded value: +"°C" - added
Output schema / properties / ta / x-unitAdded value: +"°C"
- Changed
design_rbs1 field changed- added
Output schema / properties / dgTotal / x-unitAdded value: +"kcal/mol"
- Changed
design_saturation_primers3 fields changed- added
Output schema / properties / forwardTemperature / x-unitAdded value: +"°C" - added
Output schema / properties / overlapTemperature / x-unitAdded value: +"°C" - added
Output schema / properties / reverseTemperature / x-unitAdded value: +"°C"
- Changed
draw_alignment2 fields changed- added
Output schema / properties / height / x-unitAdded value: +"px" - added
Output schema / properties / width / x-unitAdded value: +"px"
- Changed
draw_gel2 fields changed- added
Output schema / properties / height / x-unitAdded value: +"px" - added
Output schema / properties / width / x-unitAdded value: +"px"
- Changed
draw_trace2 fields changed- added
Output schema / properties / height / x-unitAdded value: +"px" - added
Output schema / properties / width / x-unitAdded value: +"px"
- Changed
draw_tree2 fields changed- added
Output schema / properties / height / x-unitAdded value: +"px" - added
Output schema / properties / width / x-unitAdded value: +"px"
- Changed
export_map_svg2 fields changed- added
Output schema / properties / height / x-unitAdded value: +"px" - added
Output schema / properties / width / x-unitAdded value: +"px"
- Changed
fastq_qc1 field changed- added
Output schema / properties / gcDeviationPercent / x-unitAdded value: +"%"
- Changed
find_orfs1 field changed- added
Output schema / properties / longest / x-unitAdded value: +"bp"
- Changed
fold_rna1 field changed- added
Output schema / properties / dg / x-unitAdded value: +"kcal/mol"
- Changed
fusion_pcr1 field changed- added
Output schema / properties / productTm / x-unitAdded value: +"°C"
- Changed
get_open_record1 field changed- added
Output schema / properties / length / x-unitAdded value: +"bp"
- Changed
get_selection1 field changed- added
Output schema / properties / length / x-unitAdded value: +"bp"
- Changed
graft_antibody_cdrs1 field changed- added
Output schema / properties / identity / x-unitAdded value: +"%"
- Changed
humanize_antibody1 field changed- added
Output schema / properties / identity / x-unitAdded value: +"%"
- Changed
load_record1 field changed- added
Output schema / properties / length / x-unitAdded value: +"bp"
- Changed
load_trace1 field changed- added
Output schema / properties / expectedAccuracy / x-unitAdded value: +"%"
- Changed
melt_profile1 field changed- added
Output schema / properties / tm50 / x-unitAdded value: +"°C"
- Changed
melting_temperature3 fields changed- added
Output schema / properties / baseTm / x-unitAdded value: +"°C" - added
Output schema / properties / gc / x-unitAdded value: +"%" - added
Output schema / properties / tm / x-unitAdded value: +"°C"
- Changed
pcr_amplify4 fields changed- added
Output schema / properties / annealingTempC / x-unitAdded value: +"°C" - added
Output schema / properties / crossDimerTmC / x-unitAdded value: +"°C" - added
Output schema / properties / forwardTmC / x-unitAdded value: +"°C" - added
Output schema / properties / reverseTmC / x-unitAdded value: +"°C"
- Changed
peptide_mass2 fields changed- added
Output schema / properties / average / x-unitAdded value: +"Da" - added
Output schema / properties / monoisotopic / x-unitAdded value: +"Da"
- Changed
plan_thermocycler_program1 field changed- added
Output schema / properties / denatureC / x-unitAdded value: +"°C"
- Changed
primer_check1 field changed- added
Output schema / properties / bestIdentityPct / x-unitAdded value: +"%"
- Changed
protein_disorder_metapredict1 field changed- added
Output schema / properties / percentDisordered / x-unitAdded value: +"%"
- Changed
protein_properties5 fields changed- added
Output schema / properties / boman / x-unitAdded value: +"kcal/mol" - added
Output schema / properties / extinctionCystines / x-unitAdded value: +"M⁻¹ cm⁻¹" - added
Output schema / properties / extinctionReduced / x-unitAdded value: +"M⁻¹ cm⁻¹" - added
Output schema / properties / monoisotopicMw / x-unitAdded value: +"Da" - added
Output schema / properties / mw / x-unitAdded value: +"Da"
- Changed
read_sequencing_qc1 field changed- added
Output schema / properties / contaminationPct / x-unitAdded value: +"%"
- Changed
read_structure2 fields changed- added
Output schema / properties / extent / x-unitAdded value: +"Å" - added
Output schema / properties / resolution / x-unitAdded value: +"Å"
- Changed
record_composition2 fields changed- added
Output schema / properties / atPercent / x-unitAdded value: +"%" - added
Output schema / properties / gcPercent / x-unitAdded value: +"%"
- Changed
score_overhang_fidelity1 field changed- added
Output schema / properties / percent / x-unitAdded value: +"%"
- Changed
screen_contamination1 field changed- added
Output schema / properties / contaminatedPct / x-unitAdded value: +"%"
- Changed
screen_oligo_structure3 fields changed- added
Output schema / properties / worstAnyTmC / x-unitAdded value: +"°C" - added
Output schema / properties / worstEndTmC / x-unitAdded value: +"°C" - added
Output schema / properties / worstHairpinTmC / x-unitAdded value: +"°C"
- Changed
verify_construct1 field changed- added
Output schema / properties / identity / x-unitAdded value: +"%"
- Changed
verify_read2 fields changed- added
Output schema / properties / coveragePct / x-unitAdded value: +"%" - added
Output schema / properties / identity / x-unitAdded value: +"%"
9 tool updates
- Changed
align_sequences2 fields changed- added
Output schema / properties / figureAdded value: +{ + "description": "the alignment's first 80 columns drawn as the MSA canvas opens on them: rows named, residues shaded by column identity, the conservation line under the block. draw_alignment draws any other window", + "type": [ + "string", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "rows", - "length", - "count", - "consensus", - "alignedSequences", - "conservation", - "engine", - "scores", - "guideTreeNewick", - "fit" -]New value: +[ + "rows", + "length", + "count", + "consensus", + "alignedSequences", + "conservation", + "engine", + "scores", + "guideTreeNewick", + "figure", + "fit" +]
- Changed
alignment_window2 fields changed- added
Output schema / properties / depthPlotAdded value: +{ + "description": "the coverage track as the pileup draws it: each bin's lowest, mean and highest per-base depth over ALL reads, so a dropout narrower than a bin still shows in the minimum", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "reads", - "read_count", - "hidden", - "sampled", - "window", - "depth_mean", - "depth_max", - "coverage", - "insert_size" -]New value: +[ + "reads", + "read_count", + "hidden", + "sampled", + "window", + "depth_mean", + "depth_max", + "coverage", + "depthPlot", + "insert_size" +]
- Changed
assess_small_molecule2 fields changed- added
Output schema / properties / structureAdded value: +{ + "description": "the 2D structure every reading was taken on, drawn by RDKit with implicit hydrogens as the chemistry tab opens it", + "type": [ + "string", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "summary", - "canonical_smiles", - "descriptors", - "rules", - "alerts", - "boiled_egg", - "formula", - "synthetic_accessibility", - "np_likeness", - "solubility", - "bioavailability_radar", - "scaffold", - "qed", - "atom_contributions" -]New value: +[ + "summary", + "canonical_smiles", + "structure", + "descriptors", + "rules", + "alerts", + "boiled_egg", + "formula", + "synthetic_accessibility", + "np_likeness", + "solubility", + "bioavailability_radar", + "scaffold", + "qed", + "atom_contributions" +]
- Changed
compare_reads_to_reference2 fields changed- added
Output schema / properties / alignmentFigureAdded value: +{ + "description": "the reference and every read in the shared frame, 80 columns around the first ACCEPTED change (else the first difference, else the start), shaded by column identity; draw_alignment draws any other window of `alignedReads`", + "type": [ + "string", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "consensus", - "variants", - "accepted", - "coveragePct", - "identityPct", - "perRead", - "gaps", - "conclusion", - "cautions", - "derivation", - "record" -]New value: +[ + "consensus", + "alignmentFigure", + "variants", + "accepted", + "coveragePct", + "identityPct", + "perRead", + "gaps", + "conclusion", + "cautions", + "derivation", + "record" +]
- Changed
export_map_svg7 fields changed- added
Input schema / properties / endAdded value: +{ + "description": "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.", + "minimum": 1, + "type": "number" +} - added
Input schema / properties / layoutAdded value: +{ + "default": "circular", + "description": "circular: the ring; linear: the record unrolled into rows, features in lanes under a ruler and sites above it.", + "enum": [ + "circular", + "linear" + ], + "type": "string" +} - added
Input schema / properties / show_basesAdded value: +{ + "default": false, + "description": "linear only: draw both strands' bases over the ruler; rows wrap to keep each base readable. Only applies when layout is linear.", + "type": "boolean" +} - added
Input schema / properties / startAdded value: +{ + "description": "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.", + "minimum": 1, + "type": "number" +} - added
Output schema / properties / rowsAdded value: +{ + "description": "rows a linear map wrapped into; 0 for the circular layout", + "type": "number" +} - changed
Output schema / properties / sites / descriptionPrevious value: -"cut sites drawn in the outer ring"New value: +"cut sites drawn (the outer ring, or the ticks above a linear map's ruler)" - changed
Output schema / requiredPrevious value: -[ - "svg", - "width", - "height", - "sites" -]New value: +[ + "svg", + "width", + "height", + "sites", + "rows" +]
- Added
fetch_article - Added
fetch_clinvar_vcf - Added
find_accessions - Changed
variant_call_summary3 fields changed- added
Output schema / properties / indelPlotAdded value: +{ + "description": "sites per indel length (ALT minus REF), deletions left of zero and insertions right of it", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - added
Output schema / properties / substitutionMapAdded value: +{ + "description": "the twelve directed substitutions as a REF by ALT grid, the Summary tab’s bars as one picture; the diagonal is empty, since a base does not substitute for itself", + "properties": { + "cols": { + "items": { + "type": "string" + }, + "type": "array" + }, + "label": { + "type": "string" + }, + "rows": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "values": { + "items": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + }, + "type": "array" + } + }, + "required": [ + "rows", + "cols", + "values", + "label" + ], + "type": [ + "object", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "summary", - "counts", - "tstv", - "substitutions", - "indel_lengths", - "per_contig", - "filters", - "qual", - "per_sample", - "not_counted" -]New value: +[ + "summary", + "counts", + "tstv", + "substitutions", + "indel_lengths", + "substitutionMap", + "indelPlot", + "per_contig", + "filters", + "qual", + "per_sample", + "not_counted" +]
5 tool updates
- Changed
differential_expression2 fields changed- added
Output schema / properties / meanCountsAdded value: +{ + "description": "DESeq2 runs only (empty under edgeR and voom): every tested gene with its mean normalized count (baseMean), 'gene value' per line: the gene weights for a Wallenius-weighted over-representation test, which corrects for the extra power to call well-counted genes", + "type": "string" +} - changed
Output schema / requiredPrevious value: -[ - "genes", - "summary", - "significantGenes", - "upGenes", - "downGenes", - "testedGenes", - "rankedList", - "maPlot", - "volcano", - "dispersionPlot", - "samplePca", - "sampleDistances" -]New value: +[ + "genes", + "summary", + "significantGenes", + "upGenes", + "downGenes", + "testedGenes", + "rankedList", + "meanCounts", + "maPlot", + "volcano", + "dispersionPlot", + "samplePca", + "sampleDistances" +]
- Added
gene_set_camera - Changed
gene_set_enrichment13 fields changed- added
Input schema / properties / adaptiveAdded value: +{ + "default": false, + "description": "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.", + "type": "boolean" +} - added
Input schema / properties / engineAdded value: +{ + "default": "clusterProfiler", + "description": "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-values; BH only, no q-value.", + "enum": [ + "clusterProfiler", + "fgsea" + ], + "type": "string" +} - changed
Input schema / properties / eps / descriptionPrevious value: -"floor for multilevel p-values; 0 estimates them however small."New value: +"floor for multilevel p-values; 0 estimates them however small. Only applies when method is multilevel." - added
Input schema / properties / maxPermAdded value: +{ + "default": 100000, + "description": "adaptive: the most draws any set gets. Only applies when adaptive is true.", + "minimum": 1, + "type": "number" +} - added
Input schema / properties / methodAdded value: +{ + "default": "multilevel", + "description": "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 list (slower: every set is re-scored along every permuted list). The permutation methods score both tails whatever the score type. Only applies when engine is clusterProfiler.", + "enum": [ + "multilevel", + "sample", + "permute" + ], + "type": "string" +} - added
Input schema / properties / minPermAdded value: +{ + "default": 101, + "description": "adaptive: the first batch for every set. Only applies when adaptive is true.", + "minimum": 1, + "type": "number" +} - changed
Input schema / properties / nPermSimple / descriptionPrevious value: -"permutations for the first, simple p-value estimate and the NES."New value: +"multilevel: permutations for the first, simple p-value estimate and the NES. Only applies when method is multilevel." - added
Input schema / properties / npermAdded value: +{ + "default": 0, + "description": "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.", + "minimum": 0, + "type": "number" +} - added
Input schema / properties / permutationsAdded value: +{ + "default": 1000, + "description": "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.", + "minimum": 1, + "type": "number" +} - added
Input schema / properties / pvalThresholdAdded value: +{ + "default": 0.1, + "description": "adaptive: a set whose p-value rises above this stops drawing. Only applies when adaptive is true.", + "maximum": 1, + "minimum": 0, + "type": "number" +} - changed
Input schema / properties / sampleSize / descriptionPrevious value: -"multilevel samples per level (made odd)."New value: +"multilevel samples per level (made odd). Only applies when method is multilevel." - changed
Input schema / properties / scoreType / descriptionPrevious value: -"std: both tails; pos or neg: one-tailed, for a statistic with one meaningful sign."New value: +"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." - changed
Input schema / properties / seed / descriptionPrevious value: -"seeds the permutations; the same seed gives the same p-values as enrichit."New value: +"seeds the permutations; the same seed gives the same p-values as the chosen engine in R (fgsea: set.seed(seed) before the call)."
- Changed
gene_set_overrepresentation1 field changed- added
Input schema / properties / weightsAdded value: +{ + "default": "", + "description": "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 (BiasedUrn), each set's odds being its members' mean weight over the rest of the background's, so a set of well-counted or long genes is not called for being easy to detect. Background genes without a weight take the median; weights at or below 0 are lifted to the smallest positive one. Empty is the unweighted test.", + "type": "string" +}
- Added
resolve_gene_sets
4 tool updates
- Added
add_notebook_figure - Changed
assemble_index_oligos1 field changed- changed
Input schema / properties / reverse_complement_tag / descriptionPrevious value: -"append the tag as its reverse complement, as the instrument requires for some read orientations. Advanced."New value: +"use each tag as its reverse complement, in an adapter or on a primer, as the instrument requires for some read orientations. Advanced."
- Changed
design_barcodes4 fields changed- added
Input schema / properties / filter_self_complementaryAdded value: +{ + "default": true, + "description": "reject barcodes that are their own reverse complement. Advanced.", + "type": "boolean" +} - added
Input schema / properties / iterationsAdded value: +{ + "default": 100, + "description": "random restarts of the Conway closure (sampling) or generations of the evolutionary search (ashlock); DNABarcodes' default. Only applies when heuristic is sampling or ashlock.", + "minimum": 1, + "type": "number" +} - added
Input schema / properties / populationAdded value: +{ + "default": 200, + "description": "chromosomes carried per Ashlock generation; DNABarcodes' default. Only applies when heuristic is ashlock.", + "minimum": 2, + "type": "number" +} - added
Input schema / properties / seedAdded value: +{ + "default": 1, + "description": "PRNG seed for a stochastic search: the same seed always gives the same set. Only applies when heuristic is sampling or ashlock.", + "type": "number" +}
- Changed
record_experiment2 fields changed- added
Output schema / properties / unresolvedAdded value: +{ + "description": "`{ references, citations }`: every `@` / `!` / `&` reference in the stored body that names nothing in this workspace, as written, and every citation key that is not a DOI, PMID or PMCID. Empty lists mean every reference resolves; fix and append when they are not. Null when the write ran without the check (a blocking workflow run)" +} - changed
Output schema / requiredPrevious value: -[ - "entry_id", - "created", - "title", - "tags", - "crossRefs", - "collection", - "bodyChars" -]New value: +[ + "entry_id", + "created", + "title", + "tags", + "crossRefs", + "collection", + "unresolved", + "bodyChars" +]
3 tool updates
- Changed
lookup_gene1 field changed- changed
Input schema / properties / source / enumPrevious value: -[ - "ensembl", - "mygene", - "ucsc", - "gtex", - "biomart" -]New value: +[ + "ncbi-gene", + "hgnc", + "ensembl", + "mygene", + "ucsc", + "gtex", + "biomart" +]
- Changed
lookup_ontology1 field changed- changed
Input schema / properties / source / enumPrevious value: -[ - "ols", - "quickgo", - "reactome", - "kegg", - "rfam", - "cellguide", - "panglaodb", - "antibodyregistry" -]New value: +[ + "ols", + "ncbi-taxonomy", + "quickgo", + "reactome", + "kegg", + "rfam", + "cellguide", + "panglaodb", + "antibodyregistry", + "identifiers-org" +]
- Changed
query_database2 fields changed- changed
Input schema / properties / authority / descriptionPrevious value: -"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), crossref (Crossref — literature), arxiv (arXiv — literature), biorxiv (bioRxiv — literature), medrxiv (medRxiv — literature), datacite (DataCite — literature), ensembl (Ensembl REST — genomics), ucsc (UCSC Genome Browser API — genomics), biomart (Ensembl BioMart — genomics), mygene (MyGene.info — genomics), gnomad (gnomAD (Broad) — genomics), clinvar (NCBI ClinVar — genomics), dbsnp (NCBI dbSNP — genomics), variation (NCBI Variation Services — genomics), cadd (CADD (Kircher lab) — genomics), gtex (GTEx Portal — genomics), eqtlcatalogue (eQTL Catalogue (EBI) — genomics), gwascatalog (GWAS Catalog (EBI/NHGRI) — genomics), pheweb (PheWeb / FinnGen — genomics), uniprot (UniProt — proteins), interpro (InterPro / Pfam (EBI) — proteins), string (STRING — proteins), proteinatlas (Human Protein Atlas — proteins), alphafold (AlphaFold DB (EBI) — proteins), pdb (RCSB PDB — proteins), emdb (EMDB (EBI) — proteins), complexportal (Complex Portal (EBI) — proteins), intact (IntAct (EBI) — proteins), chembl (ChEMBL (EBI) — chemistry), pubchem (PubChem (NCBI) — chemistry), chebi (ChEBI (EBI) — chemistry), bindingdb (BindingDB — chemistry), zinc (ZINC (CartBlanche, UCSF) — chemistry), rhea (Rhea (EBI) — chemistry), clinicaltrials (ClinicalTrials.gov — clinical), openfda (openFDA — clinical), opentargets (Open Targets Platform — clinical), civic (CIViC — clinical), clingen (ClinGen (erepo.genome.network) — clinical), cosmic (COSMIC via NLM Clinical Tables — clinical), depmap (Cell Model Passports (Sanger) — clinical), cbioportal (cBioPortal — clinical), geo (NCBI GEO — omics), arrayexpress (ArrayExpress / BioStudies (EBI) — omics), pride (PRIDE (EBI) — omics), metabolights (MetaboLights (EBI) — omics), mgnify (MGnify (EBI) — omics), encode (ENCODE Project — omics), jaspar (JASPAR (Elixir) — omics), unibind (UniBind (Univ. of Oslo) — omics), cellguide (CellGuide (CZI CELLxGENE) — cells), panglaodb (PanglaoDB — cells), antibodyregistry (Antibody Registry (RRID) — cells), ols (OLS4 (EBI) — ontology), quickgo (QuickGO (EBI) — ontology), reactome (Reactome — ontology), kegg (KEGG — ontology), rfam (Rfam (EBI) — ontology), grantsgov (Grants.gov — funding)."New value: +"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), crossref (Crossref — literature), arxiv (arXiv — literature), biorxiv (bioRxiv — literature), medrxiv (medRxiv — literature), datacite (DataCite — literature), ensembl (Ensembl REST — genomics), ucsc (UCSC Genome Browser API — genomics), biomart (Ensembl BioMart — genomics), mygene (MyGene.info — genomics), ncbi-gene (NCBI Gene (E-utilities) — genomics), hgnc (HGNC (genenames.org) — genomics), gnomad (gnomAD (Broad) — genomics), clinvar (NCBI ClinVar — genomics), dbsnp (NCBI dbSNP — genomics), variation (NCBI Variation Services — genomics), cadd (CADD (Kircher lab) — genomics), gtex (GTEx Portal — genomics), eqtlcatalogue (eQTL Catalogue (EBI) — genomics), gwascatalog (GWAS Catalog (EBI/NHGRI) — genomics), pheweb (PheWeb / FinnGen — genomics), uniprot (UniProt — proteins), interpro (InterPro / Pfam (EBI) — proteins), string (STRING — proteins), proteinatlas (Human Protein Atlas — proteins), alphafold (AlphaFold DB (EBI) — proteins), pdb (RCSB PDB — proteins), emdb (EMDB (EBI) — proteins), complexportal (Complex Portal (EBI) — proteins), intact (IntAct (EBI) — proteins), chembl (ChEMBL (EBI) — chemistry), pubchem (PubChem (NCBI) — chemistry), chebi (ChEBI (EBI) — chemistry), bindingdb (BindingDB — chemistry), zinc (ZINC (CartBlanche, UCSF) — chemistry), rhea (Rhea (EBI) — chemistry), clinicaltrials (ClinicalTrials.gov — clinical), openfda (openFDA — clinical), opentargets (Open Targets Platform — clinical), civic (CIViC — clinical), clingen (ClinGen (erepo.genome.network) — clinical), cosmic (COSMIC via NLM Clinical Tables — clinical), depmap (Cell Model Passports (Sanger) — clinical), cbioportal (cBioPortal — clinical), geo (NCBI GEO — omics), arrayexpress (ArrayExpress / BioStudies (EBI) — omics), pride (PRIDE (EBI) — omics), metabolights (MetaboLights (EBI) — omics), mgnify (MGnify (EBI) — omics), encode (ENCODE Project — omics), jaspar (JASPAR (Elixir) — omics), unibind (UniBind (Univ. of Oslo) — omics), cellguide (CellGuide (CZI CELLxGENE) — cells), panglaodb (PanglaoDB — cells), antibodyregistry (Antibody Registry (RRID) — cells), ols (OLS4 (EBI) — ontology), quickgo (QuickGO (EBI) — ontology), identifiers-org (identifiers.org registry — ontology), ncbi-taxonomy (NCBI Taxonomy (E-utilities) — ontology), reactome (Reactome — ontology), kegg (KEGG — ontology), rfam (Rfam (EBI) — ontology), grantsgov (Grants.gov — funding)." - changed
Input schema / properties / authority / enumPrevious value: -[ - "pubmed", - "pmc-idconv", - "europepmc", - "openalex", - "crossref", - "arxiv", - "biorxiv", - "medrxiv", - "datacite", - "ensembl", - "ucsc", - "biomart", - "mygene", - "gnomad", - "clinvar", - "dbsnp", - "variation", - "cadd", - "gtex", - "eqtlcatalogue", - "gwascatalog", - "pheweb", - "uniprot", - "interpro", - "string", - "proteinatlas", - "alphafold", - "pdb", - "emdb", - "complexportal", - "intact", - "chembl", - "pubchem", - "chebi", - "bindingdb", - "zinc", - "rhea", - "clinicaltrials", - "openfda", - "opentargets", - "civic", - "clingen", - "cosmic", - "depmap", - "cbioportal", - "geo", - "arrayexpress", - "pride", - "metabolights", - "mgnify", - "encode", - "jaspar", - "unibind", - "cellguide", - "panglaodb", - "antibodyregistry", - "ols", - "quickgo", - "reactome", - "kegg", - "rfam", - "grantsgov" -]New value: +[ + "pubmed", + "pmc-idconv", + "europepmc", + "openalex", + "crossref", + "arxiv", + "biorxiv", + "medrxiv", + "datacite", + "ensembl", + "ucsc", + "biomart", + "mygene", + "ncbi-gene", + "hgnc", + "gnomad", + "clinvar", + "dbsnp", + "variation", + "cadd", + "gtex", + "eqtlcatalogue", + "gwascatalog", + "pheweb", + "uniprot", + "interpro", + "string", + "proteinatlas", + "alphafold", + "pdb", + "emdb", + "complexportal", + "intact", + "chembl", + "pubchem", + "chebi", + "bindingdb", + "zinc", + "rhea", + "clinicaltrials", + "openfda", + "opentargets", + "civic", + "clingen", + "cosmic", + "depmap", + "cbioportal", + "geo", + "arrayexpress", + "pride", + "metabolights", + "mgnify", + "encode", + "jaspar", + "unibind", + "cellguide", + "panglaodb", + "antibodyregistry", + "ols", + "quickgo", + "identifiers-org", + "ncbi-taxonomy", + "reactome", + "kegg", + "rfam", + "grantsgov" +]
11 tool updates
- Changed
analyze_melt_curves4 fields changed- added
Output schema / properties / derivativePlotAdded value: +{ + "description": "`plate` only: −dF/dT of each reaction after normalisation and smoothing, the curve its peaks are called on, one line per reaction. Null for `vertex` and `curve`, which fit near the extremum and report no whole derivative", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - added
Output schema / properties / meltPlotAdded value: +{ + "description": "the melt curves as read from the table, one line per reaction, fluorescence against temperature. Every engine reads this same input", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - added
Output schema / properties / targetsAdded value: +{ + "description": "`plate` only: per target, the reactions that contributed a product peak and their averaged Tm against the expected one. Empty for `vertex` and `curve`" +} - changed
Output schema / requiredPrevious value: -[ - "reactions", - "count", - "meanTm", - "noPeak", - "classified", - "engine", - "replicateSpread" -]New value: +[ + "reactions", + "count", + "meanTm", + "noPeak", + "classified", + "engine", + "replicateSpread", + "targets", + "meltPlot", + "derivativePlot" +]
- Changed
audit_barcodes6 fields changed- added
Output schema / properties / baseCompositionAdded value: +{ + "description": "the fraction of the set reading each base at each cycle", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - added
Output schema / properties / distanceHistogramAdded value: +{ + "description": "how many PAIRS sit at each distance under the chosen metric: the shape behind the minimum", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - added
Output schema / properties / gcHistogramAdded value: +{ + "description": "how many barcodes sit at each GC percentage", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - added
Output schema / properties / neighbourHistogramAdded value: +{ + "description": "how many BARCODES have each nearest-neighbour distance: where the weak links are", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - added
Output schema / properties / statisticsAdded value: +{ + "description": "the whole-set statistics the four charts above are drawn from, which a min-distance figure hides: GC mean, spread and range, Shannon entropy per cycle, the fraction reading each base at each cycle, groups sharing a prefix in the first cycles read, duplicates, and the per-metric distance distributions" +} - changed
Output schema / requiredPrevious value: -[ - "audit", - "analysis", - "matrices", - "distanceMap", - "kept", - "dropped" -]New value: +[ + "audit", + "analysis", + "matrices", + "distanceMap", + "distanceHistogram", + "neighbourHistogram", + "gcHistogram", + "baseComposition", + "statistics", + "kept", + "dropped" +]
- Changed
check_color_balance2 fields changed- added
Output schema / properties / channelPlotAdded value: +{ + "description": "the fraction of the pool producing signal in each channel at each index cycle; the series are named after the channels, and their colours are not the dyes", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "tier", - "ok", - "violations", - "cycles", - "acrossChemistries" -]New value: +[ + "tier", + "ok", + "violations", + "cycles", + "channelPlot", + "acrossChemistries" +]
- Changed
copy_number_read2 fields changed- added
Output schema / properties / lanesAdded value: +{ + "description": "the tracks above drawn as the canvas draws them: one lane per graph over the same window, the bucket min-max envelope with its mean over it, the compared sample's envelope behind it where `compare` named a second file, and the marker lane underneath, because a gap in the probes is not a deletion. Null when no graph was decimated — no chromosome was selected, or none of its markers carried a value", + "type": [ + "string", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "summary", - "provenance", - "data_sets", - "compared", - "chromosomes", - "index_source", - "tracks" -]New value: +[ + "summary", + "provenance", + "data_sets", + "compared", + "chromosomes", + "index_source", + "tracks", + "lanes" +]
- Changed
crispr_design_guides2 fields changed- added
Output schema / properties / regionAdded value: +{ + "description": "the window the guides were filtered to, resolved: start, end, and whether it is the whole molecule. Reported because `region_start`/`region_end` are optional and their default is the molecule's length, which a caller holding only this result does not have — without it, `count` of `totalCandidates` cannot be read" +} - changed
Output schema / requiredPrevious value: -[ - "guides", - "count", - "totalCandidates", - "topSpacer" -]New value: +[ + "guides", + "count", + "totalCandidates", + "topSpacer", + "region" +]
- Changed
design_genetic_circuit2 fields changed- added
Output schema / properties / curvesFigureAdded value: +{ + "description": "the curves above drawn as the panel draws them: one panel per gate, all on the same log-log axes, the response as a line and this design's operating points on it, ON in bluish green and OFF in vermillion", + "type": [ + "string", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "score", - "assignment", - "truthTable", - "sequence", - "dna", - "placement", - "toxicity", - "curves", - "netlist", - "explanation", - "libraries" -]New value: +[ + "score", + "assignment", + "truthTable", + "sequence", + "dna", + "placement", + "toxicity", + "curves", + "curvesFigure", + "netlist", + "explanation", + "libraries" +]
- Changed
enzyme_collection2 fields changed- added
Output schema / properties / censusAdded value: +{ + "description": "what this collection does to the open record, counted once: bases scanned, whether the scan wrapped the origin, names asked and resolved, total cuts, and how many enzymes cut it once, twice or more. Absent when nothing is open. This is the collection panel's own reading, so the sentence the door returns and the numbers it returns cannot disagree" +} - changed
Output schema / requiredPrevious value: -[ - "enzymes", - "collection", - "count", - "unresolved", - "cutting", - "singleCutters", - "available" -]New value: +[ + "enzymes", + "collection", + "count", + "unresolved", + "census", + "cutting", + "singleCutters", + "available" +]
- Changed
infer_proteins3 fields changed- added
Input schema / properties / coverageOfAdded value: +{ + "default": "", + "description": "the accession whose sequence coverage is drawn; empty draws the first protein of the best group, as the Coverage tab opens on.", + "type": "string" +} - added
Output schema / properties / coverageMapAdded value: +{ + "description": "one protein's sequence with the peptides that identified it laid under the residues they cover, unique in blue and shared in orange: the Coverage tab's picture of `coverageOf`", + "type": [ + "string", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "proteins", - "groups", - "ambiguityGroups", - "count", - "scoreColumn", - "method" -]New value: +[ + "proteins", + "groups", + "ambiguityGroups", + "count", + "scoreColumn", + "method", + "coverageMap" +]
- Changed
optimize_sequence2 fields changed- added
Output schema / properties / gcProfileAdded value: +{ + "description": "windowed GC before and after, at each window's centre: the stretches the solver moved, which the two whole-sequence GC numbers average away", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "record", - "sequence", - "success", - "nEdits", - "gcAfter", - "caiAfter", - "candidates", - "distinct" -]New value: +[ + "record", + "sequence", + "success", + "nEdits", + "gcAfter", + "caiAfter", + "candidates", + "distinct", + "gcProfile" +]
- Changed
protein_properties34 fields changed- changed
Output schema / properties / a280 / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / aliphatic / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / aromaticity / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / atoms / descriptionPrevious value: -"total number of atoms in the molecule"New value: +"total number of atoms in the molecule, or null when a residue has no formula" - changed
Output schema / properties / atoms / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / boman / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / charge / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / elements / descriptionPrevious value: -"atom counts per element (C, H, N, O, S) behind the formula"New value: +"atom counts per element (C, H, N, O, S) behind the formula, or null when a residue has no formula" - changed
Output schema / properties / extinctionCystines / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / extinctionReduced / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / formula / descriptionPrevious value: -"molecular formula, ProtParam style (e.g. C1755H2634N466O557S5)"New value: +"molecular formula, ProtParam style (e.g. C1755H2634N466O557S5); empty when a residue has no formula" - changed
Output schema / properties / gravy / descriptionPrevious value: -"grand average of hydropathicity over `gravyScale`"New value: +"grand average of hydropathicity over `gravyScale`, or null when a residue has no value on it" - changed
Output schema / properties / gravy / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / gravyHydrophobicEnd / typePrevious value: -"string"New value: +[ + "string", + "null" +] - changed
Output schema / properties / gravyScale / typePrevious value: -"string"New value: +[ + "string", + "null" +] - changed
Output schema / properties / gravyZeroIsMeaningful / typePrevious value: -"boolean"New value: +[ + "boolean", + "null" +] - changed
Output schema / properties / helix / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / instability / descriptionPrevious value: -"instability index (>40 = unstable in vivo)"New value: +"instability index (>40 = unstable in vivo), or null when a residue the Guruprasad table has no row for makes it undefined — refused rather than computed on a spliced sequence" - changed
Output schema / properties / instability / typePrevious value: -"number"New value: +[ + "number", + "null" +] - added
Output schema / properties / lengthAdded value: +{ + "description": "residues analysed, including any the mass tables have no row for", + "type": [ + "number", + "null" + ] +} - changed
Output schema / properties / momentHelix / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / momentSheet / typePrevious value: -"number"New value: +[ + "number", + "null" +] - added
Output schema / properties / momentWindowAdded value: +{ + "description": "the window the two moments were measured over, after the clamp to the sequence length — a short peptide is not measured over 11 residues it does not have", + "type": [ + "number", + "null" + ] +} - changed
Output schema / properties / monoisotopicMw / descriptionPrevious value: -"monoisotopic molecular weight [Da] — what mass spectrometry reports"New value: +"monoisotopic molecular weight [Da] — what mass spectrometry reports. Null when a residue has no mass, rather than a mass for a different molecule" - changed
Output schema / properties / monoisotopicMw / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / properties / mw / descriptionPrevious value: -"molecular weight [Da]"New value: +"molecular weight [Da] — a FLOOR when `nonStandard` is non-empty, because ProtParam has no mass for those letters and still counts them in the length" - changed
Output schema / properties / mw / typePrevious value: -"number"New value: +[ + "number", + "null" +] - added
Output schema / properties / nonStandardAdded value: +{ + "description": "residues with no mass at all (X, B, Z, gaps, *), with their positions: excluded from `mw`, `monoisotopicMw`, `formula` and `elements`, still counted in `length`. Empty on a clean chain" +} - changed
Output schema / properties / pI / typePrevious value: -"number"New value: +[ + "number", + "null" +] - added
Output schema / properties / scaleNonStandardAdded value: +{ + "description": "residues that ARE weighed but have no per-residue scale value (U, O). They are why `gravy` and `instability` can come back null on a sequence whose mass is exact" +} - changed
Output schema / properties / sheet / typePrevious value: -"number"New value: +[ + "number", + "null" +] - added
Output schema / properties / stableAdded value: +{ + "description": "ProtParam's own reading of the index: at or below 40. Null exactly when `instability` is — there is no verdict without a value", + "type": [ + "boolean", + "null" + ] +} - changed
Output schema / properties / turn / typePrevious value: -"number"New value: +[ + "number", + "null" +] - changed
Output schema / requiredPrevious value: -[ - "mw", - "pI", - "instability", - "boman", - "momentHelix", - "momentSheet", - "monoisotopicMw", - "formula", - "atoms", - "extinctionReduced", - "extinctionCystines", - "a280", - "nTerminal", - "halfLifeMammalian", - "halfLifeYeast", - "halfLifeEcoli", - "gravy", - "gravyScale", - "gravyHydrophobicEnd", - "gravyZeroIsMeaningful", - "aliphatic", - "aromaticity", - "helix", - "turn", - "sheet", - "charge", - "composition", - "compositionPercent", - "elements" -]New value: +[ + "mw", + "length", + "nonStandard", + "scaleNonStandard", + "pI", + "instability", + "stable", + "boman", + "momentHelix", + "momentSheet", + "momentWindow", + "monoisotopicMw", + "formula", + "atoms", + "extinctionReduced", + "extinctionCystines", + "a280", + "nTerminal", + "halfLifeMammalian", + "halfLifeYeast", + "halfLifeEcoli", + "gravy", + "gravyScale", + "gravyHydrophobicEnd", + "gravyZeroIsMeaningful", + "aliphatic", + "aromaticity", + "helix", + "turn", + "sheet", + "charge", + "composition", + "compositionPercent", + "elements" +]
- Changed
read_sequencing_qc2 fields changed- added
Output schema / properties / depthProfileAdded value: +{ + "description": "the depth track drawn: the MINIMUM and the mean depth per window, with the coverage line and the track's median as rules, so a drop-out reads as a drop-out rather than being averaged away. Null for a Plasmidsaurus summary, which measures no track", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "kind", - "perbase", - "minCoverage", - "positionsAbove20x", - "contaminationPct", - "contaminationSource", - "plasmidsaurus", - "shape", - "longestGap", - "largestStepFold", - "reading" -]New value: +[ + "kind", + "perbase", + "minCoverage", + "positionsAbove20x", + "contaminationPct", + "contaminationSource", + "plasmidsaurus", + "shape", + "longestGap", + "largestStepFold", + "depthProfile", + "reading" +]
6 tool updates
- Changed
check_scorpion_stem1 field changed- added
Input schema / properties / conditions / properties / selfcompAdded value: +{ + "description": "both strands are one self-complementary oligo (the concentration term becomes dnac1 rather than dnac1 − dnac2/2).", + "type": "boolean" +}
- Changed
design_codehop1 field changed- added
Input schema / properties / conditions / properties / selfcompAdded value: +{ + "description": "both strands are one self-complementary oligo (the concentration term becomes dnac1 rather than dnac1 − dnac2/2).", + "type": "boolean" +}
- Changed
design_gibson_primers1 field changed- added
Input schema / properties / conditions / properties / selfcompAdded value: +{ + "description": "both strands are one self-complementary oligo (the concentration term becomes dnac1 rather than dnac1 − dnac2/2).", + "type": "boolean" +}
- Changed
design_primer_pairs1 field changed- added
Input schema / properties / conditions / properties / selfcompAdded value: +{ + "description": "both strands are one self-complementary oligo (the concentration term becomes dnac1 rather than dnac1 − dnac2/2).", + "type": "boolean" +}
- Changed
design_primers1 field changed- added
Input schema / properties / conditions / properties / selfcompAdded value: +{ + "description": "both strands are one self-complementary oligo (the concentration term becomes dnac1 rather than dnac1 − dnac2/2).", + "type": "boolean" +}
- Changed
design_qpcr_assay1 field changed- added
Input schema / properties / conditions / properties / selfcompAdded value: +{ + "description": "both strands are one self-complementary oligo (the concentration term becomes dnac1 rather than dnac1 − dnac2/2).", + "type": "boolean" +}
2 tool updates
- Changed
differential_expression18 fields changed- added
Input schema / properties / avgTxLengthAdded value: +{ + "default": "", + "description": "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, times median-of-ratios size factors), correcting for changes in transcript usage between samples. Only applies when method is DESeq2.", + "type": "string" +} - added
Input schema / properties / betaPriorAdded value: +{ + "default": false, + "description": "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 instead of `shrink`. Only applies when method is DESeq2.", + "type": "boolean" +} - added
Input schema / properties / blindAdded value: +{ + "default": true, + "description": "fit the transformation's dispersion trend under ~ 1, blind to the design (DESeq2's default, for quality assessment); off reuses the fitted design and trend, for downstream use when large differences between groups are expected. Only applies when method is DESeq2.", + "type": "boolean" +} - changed
Input schema / properties / fitType / descriptionPrevious value: -"the dispersion trend: parametric (asymptDisp + extraPois / mean, DESeq2's default) or the mean of gene-wise estimates. Only applies when method is DESeq2."New value: +"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 gene-wise estimates, or glmGamPoi (gene-wise maximum likelihood by glmGamPoi, a local-median trend and quasi-likelihood shrinkage; with test LRT the p-values are glmGamPoi's quasi-likelihood F test; no outlier replacement, minmu 1e-6, no observation weights). Only applies when method is DESeq2." - changed
Input schema / properties / fitType / enumPrevious value: -[ - "parametric", - "mean" -]New value: +[ + "parametric", + "local", + "mean", + "glmGamPoi" +] - added
Input schema / properties / minmuAdded value: +{ + "description": "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 (zinbwave's vignette). Only applies when method is DESeq2.", + "minimum": 0, + "type": "number" +} - added
Input schema / properties / pcaGroupAdded value: +{ + "default": "", + "description": "plotPCA's intgroup: the sample-table variables, separated by commas, that colour the samples (joined with ':' when more than one); empty is the factor of the reported comparison. Only applies when method is DESeq2.", + "type": "string" +} - added
Input schema / properties / pcaTopAdded value: +{ + "default": 500, + "description": "plotPCA's ntop: the PCA uses this many genes with the largest variance of the transformed values. Only applies when method is DESeq2.", + "minimum": 2, + "type": "number" +} - changed
Input schema / properties / sfType / descriptionPrevious value: -"size factors: median of ratios over genes with no zero (ratio), or with zeros allowed (poscounts, for sparse data). Only applies when method is DESeq2."New value: +"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 (iterate, when every gene has a zero). Only applies when method is DESeq2." - changed
Input schema / properties / sfType / enumPrevious value: -[ - "ratio", - "poscounts" -]New value: +[ + "ratio", + "poscounts", + "iterate" +] - changed
Input schema / properties / shrink / descriptionPrevious value: -"shrink the reported coefficient's log2 fold changes toward zero where the counts cannot support them (DESeq2 lfcShrink), for ranking and plotting by effect size; p-values stay the unshrunken test's. apeglm: adaptive Cauchy prior, posterior mode. ashr: mixture-of-normals prior, posterior mean. normal: DESeq2's original zero-centred Normal prior (Wald only). Only applies when method is DESeq2."New value: +"shrink the reported coefficient's or contrast's log2 fold changes toward zero where the counts cannot support them (DESeq2 lfcShrink), for ranking and plotting by effect size; p-values stay the unshrunken test's. apeglm: adaptive Cauchy prior, posterior mode (a coefficient only). ashr: mixture-of-normals prior, posterior mean. normal: DESeq2's original zero-centred Normal prior (Wald only), a contrast on the expanded model matrix. With lfcThreshold, apeglm and ashr give s-values of a false sign or a fold change inside the threshold, and normal re-tests the shrunken fit. Only applies when method is DESeq2." - added
Input schema / properties / transformAdded value: +{ + "default": "vst", + "description": "the count transformation the sample-level checks (PCA, sample distances) run on: vst (DESeq2's variance stabilizing transformation, the trend fitted on 1,000 genes; with fewer than 1,000 genes above a mean of 5 use VST), VST (varianceStabilizingTransformation, every gene), rlog (regularized log, a per-gene ridge fit, slow above ~30 samples) or normTransform (log2 of normalized count + 1, no stabilization). none skips the checks. Only applies when method is DESeq2.", + "enum": [ + "vst", + "VST", + "rlog", + "normTransform", + "none" + ], + "type": "string" +} - added
Input schema / properties / useTAdded value: +{ + "default": false, + "description": "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 only. Only applies when method is DESeq2.", + "type": "boolean" +} - added
Input schema / properties / weightsAdded value: +{ + "default": "", + "description": "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 gene's weights by their largest and uses them in the base means, the dispersion likelihoods (samples at or below 0.01 leave the Cox-Reid term), the GLM and its tests. Only applies when method is DESeq2.", + "type": "string" +} - changed
Output schema / properties / genes / descriptionPrevious value: -"one row per gene: log2FoldChange, stat (DESeq2 Wald or LRT, edgeR F, voom moderated t), pvalue, padj, why padj is NA, the normalized counts per sample; DESeq2 adds baseMean, lfcSE, the gene-wise, fitted and final dispersions, whether it was refitted and with `shrink` the shrunken fold change, its SE and s-value; edgeR and voom add logCPM, the raw, prior and posterior variance (edgeR's QL dispersion) and the total df, and voom the B-statistic"New value: +"one row per gene: log2FoldChange, stat (DESeq2 Wald or LRT, edgeR F, voom moderated t), pvalue, padj, why padj is NA, the normalized counts per sample; DESeq2 adds baseMean, lfcSE, the gene-wise, fitted and final dispersions, whether it was refitted and with `shrink` the shrunken fold change, its SE and s-value (normal with lfcThreshold: the shrunken fit's p-value and padj); edgeR and voom add logCPM, the raw, prior and posterior variance (edgeR's QL dispersion) and the total df, and voom the B-statistic" - added
Output schema / properties / sampleDistancesAdded value: +{ + "description": "DESeq2 runs only (null under edgeR and voom): the sample checks as data: the transformation and its trend, the PCA genes, percentVar, PC1 and PC2 per sample, the sample-to-sample Euclidean distance matrix over every gene and its complete-linkage clustering (leaf order, merges, heights), as the vignette's heatmap draws it; or why the checks could not run" +} - added
Output schema / properties / samplePcaAdded value: +{ + "description": "DESeq2 runs only (null under edgeR and voom): plotPCA on the transformed counts (`transform`, `blind`): PC2 against PC1 per sample, one series per `pcaGroup` level, each axis labelled with its share of the variance", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "genes", - "summary", - "significantGenes", - "upGenes", - "downGenes", - "testedGenes", - "rankedList", - "maPlot", - "volcano", - "dispersionPlot" -]New value: +[ + "genes", + "summary", + "significantGenes", + "upGenes", + "downGenes", + "testedGenes", + "rankedList", + "maPlot", + "volcano", + "dispersionPlot", + "samplePca", + "sampleDistances" +]
- Changed
run_discovery_programme1 field changed- changed
Input schema / properties / hypotheses / descriptionPrevious value: -"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 two-sided) or discover_codon_outliers (params gene as its library name, genetic_code, alt_init?, min_codons?; direction two-sided) or validate_gene_trait (params gene as its HGNC symbol, expression_test coexpression with trait_genes or tissue with tissues, categories as GWAS Catalog parent categories, alpha?; direction greater; needs no corpus) or discover_flag_rates (params flag as one of sigma70-strongest, splice-donor, splice-acceptor, homopolymer, tandem-repeat, long-repeat, inverted-repeat, record?, shuffle_k/shuffles/seed; direction greater, meaning beyond chance in the flag's own tail) or discover_tree_incongruence (params locus as its alignment file's name, permutations/seed; direction greater; the corpus is one aligned FASTA per locus) or discover_gene_tree_discordance (params gene as its alignment file's name, species_tree in Newick, replicates/sh_form/gamma_categories/seed; direction greater, meaning the gene fits another tree better; the corpus is one aligned FASTA per gene) or discover_reference_stability (params gene as its HGNC symbol, tissues?, neighbours?, pseudocount?; direction greater for more variable than its abundance peers, less for steadier, or two-sided; needs no corpus) or discover_annotation_contradictions (params annotation as a UniProt accession, or accession:start-end where the protein has several, feature signal or transmembrane, predictor for signal, decoding for transmembrane; direction less, meaning it scores below the experimentally confirmed features; needs no corpus) or discover_reference_concordance (params cq_table as the long-format Target,Sample,Group,Cq table itself, permutations/seed; direction greater, meaning the conditions rank the genes more alike than independent orders; needs no corpus). prior_belief: the proposer's belief before any result, one sample or a list of them (true, false, definitely true, maybe true, uncertain, maybe false, definitely false, cannot comment)."New value: +"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 two-sided) or discover_codon_outliers (params gene as its library name, genetic_code, alt_init?, min_codons?; direction two-sided) or validate_gene_trait (params gene as its HGNC symbol, expression_test coexpression with trait_genes or tissue with tissues, categories as GWAS Catalog parent categories, alpha?; direction greater; needs no corpus) or discover_flag_rates (params flag as one of sigma70-strongest, splice-donor, splice-acceptor, homopolymer, tandem-repeat, long-repeat, inverted-repeat, record?, shuffle_k/shuffles/seed; direction greater, meaning beyond chance in the flag's own tail) or discover_tree_incongruence (params locus as its alignment file's name, permutations/seed; direction greater; the corpus is one aligned FASTA per locus) or discover_gene_tree_discordance (params gene as its alignment file's name, species_tree in Newick, replicates/sh_form/gamma_categories/seed; direction greater, meaning the gene fits another tree better; the corpus is one aligned FASTA per gene) or discover_reference_stability (params gene as its HGNC symbol, tissues?, neighbours?, pseudocount?; direction greater for more variable than its abundance peers, less for steadier, or two-sided; needs no corpus) or discover_annotation_contradictions (params annotation as a UniProt accession, or accession:start-end where the protein has several, feature signal or transmembrane, predictor for signal, decoding for transmembrane; direction less, meaning it scores below the experimentally confirmed features; needs no corpus) or discover_reference_concordance (params cq_table as the long-format Target,Sample,Group,Cq table itself, permutations/seed; direction greater, meaning the conditions rank the genes more alike than independent orders; needs no corpus) or differential_expression (params gene as its count-table ID, symbol? as papers name it for the literature query, counts and samples as the tables themselves, and design/reference/test/reduced/contrast/name/fitType/sfType/lfcThreshold/altHypothesis/cooksFilter/cooksCutoff/minReplicatesForReplace as the tool takes them; direction greater for higher in the contrast's numerator, less for lower, or two-sided; one-sided needs the Wald test at lfcThreshold 0; needs no corpus) or gene_set_overrepresentation (params set as its GMT ID, genes, geneSets as GMT text, universe?, forceUniverse?, minGSSize?, maxGSSize?; direction greater; needs no corpus) or gene_set_enrichment (params set as its GMT ID, ranked as 'gene statistic' lines, geneSets as GMT text, minGSSize/maxGSSize/exponent/scoreType/eps/sampleSize/nPermSimple/seed; direction greater for toward the top of the list, less for the bottom, or two-sided; needs no corpus). prior_belief: the proposer's belief before any result, one sample or a list of them (true, false, definitely true, maybe true, uncertain, maybe false, definitely false, cannot comment)."
3 tool updates
- Changed
auto_annotate1 field changed- changed
Input schema / properties / libraries / descriptionPrevious value: -"which feature corpora to search, by id (an id from annotation-library/manifest.json, or \"legacy\" for the unsourced set). Empty means all of them."New value: +"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 it leaves off for their size, AMRFinderPlus and Rfam; name those to search them too."
- Changed
call_cq2 fields changed- added
Output schema / properties / amplificationPlotAdded value: +{ + "description": "the raw amplification curves as read from the plate, one line per reaction, fluorescence against cycle", + "properties": { + "mark": { + "enum": [ + "line", + "bar", + "point" + ], + "type": "string" + }, + "rules": { + "items": { + "properties": { + "label": { + "type": "string" + }, + "y": { + "type": "number" + } + }, + "required": [ + "y", + "label" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "y": { + "items": { + "type": [ + "number", + "null" + ] + }, + "type": "array" + } + }, + "required": [ + "name", + "y" + ], + "type": "object" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "x": { + "items": { + "type": "number" + }, + "type": "array" + }, + "xLabel": { + "type": "string" + }, + "yLabel": { + "type": "string" + } + }, + "required": [ + "x", + "series", + "xLabel", + "yLabel" + ], + "type": [ + "object", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "rows", - "count", - "failed", - "meanEfficiency", - "model", - "cqMethod", - "modelTable", - "methods", - "outliers", - "outlierStat", - "zeroCrossing", - "threshold", - "modelChosen", - "errorNote" -]New value: +[ + "rows", + "count", + "failed", + "meanEfficiency", + "model", + "cqMethod", + "modelTable", + "methods", + "outliers", + "outlierStat", + "zeroCrossing", + "threshold", + "modelChosen", + "errorNote", + "amplificationPlot" +]
- Added
describe_project
30 tool updates
- Added
antibody_canonical_classes - Added
antibody_position_frequencies - Changed
calculate_power2 fields changed- changed
Input schema / properties / effect / descriptionPrevious value: -"the standardised 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. Only applies when test is t or t_unequal or two_proportions or two_proportions_unequal or one_proportion or normal_mean or correlation or chisq or anova or linear_model."New value: +"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. Only applies when test is t or t_unequal or two_proportions or two_proportions_unequal or one_proportion or normal_mean or correlation or chisq or anova or linear_model." - changed
Input schema / properties / test / descriptionPrevious value: -"which test the experiment will be analysed 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, unequal group sizes, Cohen's d), two_proportions (two proportions, equal n, Cohen's h), two_proportions_unequal (two proportions, unequal n, Cohen's h), one_proportion (one proportion against a null value, Cohen's h), normal_mean (normal mean, known variance, effect d), correlation (Pearson correlation, r), chisq (chi-square goodness of fit or independence, Cohen's w), anova (balanced one-way ANOVA, Cohen's f), linear_model (linear model F test (multiple regression), Cohen's f²), t_raw (t test in raw units: difference and standard deviation), proportions_raw (two proportions in raw units: p1 and p2), anova_raw (balanced one-way ANOVA in raw units: between- and within-group variance)."New value: +"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, unequal group sizes, Cohen's d), two_proportions (two proportions, equal n, Cohen's h), two_proportions_unequal (two proportions, unequal n, Cohen's h), one_proportion (one proportion against a null value, Cohen's h), normal_mean (normal mean, known variance, effect d), correlation (Pearson correlation, r), chisq (chi-square goodness of fit or independence, Cohen's w), anova (balanced one-way ANOVA, Cohen's f), linear_model (linear model F test (multiple regression), Cohen's f²), t_raw (t test in raw units: difference and standard deviation), proportions_raw (two proportions in raw units: p1 and p2), anova_raw (balanced one-way ANOVA in raw units: between- and within-group variance)."
- Changed
call_cq4 fields changed- added
Output schema / properties / errorNoteAdded value: +{ + "description": "a plate-level note from the fit (for example a reaction the model could not fit); null when there is none", + "type": [ + "string", + "null" + ] +} - added
Output schema / properties / modelChosenAdded value: +{ + "description": "the curve model the ranking chose when the model was not given; null when it was given", + "type": [ + "string", + "null" + ] +} - added
Output schema / properties / thresholdAdded value: +{ + "description": "the fluorescence threshold every Cq was read at; null when the Cq came from `cq_method` instead", + "type": [ + "number", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "rows", - "count", - "failed", - "meanEfficiency", - "model", - "cqMethod", - "modelTable", - "methods", - "outliers", - "outlierStat", - "zeroCrossing" -]New value: +[ + "rows", + "count", + "failed", + "meanEfficiency", + "model", + "cqMethod", + "modelTable", + "methods", + "outliers", + "outlierStat", + "zeroCrossing", + "threshold", + "modelChosen", + "errorNote" +]
- Changed
cancel_research_run4 fields changed- changed
Input schema / properties / reason / descriptionPrevious value: -"why, recorded on each cancelled attempt."New value: +"why, recorded on each canceled attempt." - changed
Output schema / properties / cancelled / descriptionPrevious value: -"the hypotheses this call cancelled"New value: +"the hypotheses this call canceled" - changed
Output schema / properties / run / descriptionPrevious value: -"the whole programme as a sealed jane.research-run file: the ledger, every corpus input pinned by SHA-256, the last attempt at each hypothesis. Pass it back to continue"New value: +"the whole program as a sealed jane.research-run file: the ledger, every corpus input pinned by SHA-256, the last attempt at each hypothesis. Pass it back to continue" - changed
Output schema / properties / status / descriptionPrevious value: -"the cancelled run's status: counts, pending (now none of the cancelled), settled and cancelled hypotheses"New value: +"the canceled run's status: counts, pending (now none of the canceled), settled and canceled hypotheses"
- Changed
check_invariants2 fields changed- changed
Input schema / properties / require_start / descriptionPrevious value: -"with require_frame: the first codon must be a start codon. Advanced."New value: +"with require_frame: the first codon must be a start codon. Only applies when require_frame is true. Advanced." - changed
Input schema / properties / require_stop / descriptionPrevious value: -"with require_frame: the last codon must be a stop. Advanced."New value: +"with require_frame: the last codon must be a stop. Only applies when require_frame is true. Advanced."
- Added
compare_antibodies - Changed
design_ish_probes7 fields changed- added
Input schema / properties / kmer_canonicalAdded value: +{ + "default": false, + "description": "count a k-mer and its reverse complement as one (jellyfish -C). Off as OligoMiner's dictionary is; for a dump it must match how the dictionary was counted. Advanced.", + "type": "boolean" +} - added
Input schema / properties / kmer_dumpAdded value: +{ + "description": "`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. Advanced.", + "type": "string" +} - added
Input schema / properties / kmer_lengthAdded value: +{ + "default": 18, + "description": "k, the k-mer length counted in kmer_reference (OligoMiner's README builds 18); a dump carries its own. In nt. Only applies when kmer_reference is set.", + "maximum": 31, + "minimum": 8, + "type": "number" +} - added
Input schema / properties / kmer_referenceAdded value: +{ + "description": "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 UNCHECKED and the result says so.", + "type": "string" +} - added
Input schema / properties / kmer_thresholdAdded value: +{ + "default": 5, + "description": "drop an oligo holding any k-mer that occurs this many times or more in the reference.", + "maximum": 100000, + "minimum": 1, + "type": "number" +} - added
Output schema / properties / kmerAdded value: +{ + "description": "the k-mer screen's reading of each oligo it saw: its start, the highest count charged to it, and whether it was kept. Absent when no k-mer reference or dump was given" +} - changed
Output schema / requiredPrevious value: -[ - "probes", - "oligos", - "oligoCount", - "coveredFraction", - "stages", - "explanation", - "coverage" -]New value: +[ + "probes", + "oligos", + "oligoCount", + "coveredFraction", + "stages", + "kmer", + "explanation", + "coverage" +]
- Added
design_merfish_probes - Changed
design_rbs4 fields changed- added
Output schema / properties / achievableMaxAdded value: +{ + "description": "the strongest relative strength any candidate site reached in this search, which bounds what a target above it can get", + "type": [ + "number", + "null" + ] +} - added
Output schema / properties / achievableMinAdded value: +{ + "description": "the weakest relative strength any candidate site reached in this search, which bounds what a target below it can get", + "type": [ + "number", + "null" + ] +} - added
Output schema / properties / dgTotalAdded value: +{ + "description": "the predicted total free energy of translation initiation (ΔG_total, kcal/mol) for the designed site; null when the model could not fold it", + "type": [ + "number", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "utr", - "sd", - "full", - "spacing", - "relStrength", - "onTarget" -]New value: +[ + "utr", + "sd", + "full", + "spacing", + "relStrength", + "onTarget", + "dgTotal", + "achievableMin", + "achievableMax" +]
- Added
design_xenium_probes - Changed
discover_annotation_contradictions1 field changed- changed
Input schema / properties / decoding / descriptionPrevious value: -"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-Viterbi), optimal-accuracy (Optimal accuracy). Advanced."New value: +"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-Viterbi), optimal-accuracy (Optimal accuracy). Only applies when feature is transmembrane. Advanced."
- Changed
discover_gene_tree_discordance1 field changed- changed
Input schema / properties / replicates / descriptionPrevious value: -"RELL bootstrap replicates of the SH test. The smallest p it can give is 1 / replicates."New value: +"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)."
- Changed
discover_site_avoidance1 field changed- changed
Input schema / properties / enzymes / descriptionPrevious value: -"restrict the sweep to these enzymes' sites (NEB names). Empty sweeps every exact site in the catalogue; degenerate (IUPAC) sites are never swept and are listed in the result. Advanced."New value: +"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."
- Changed
estimate_effect_size3 fields changed- changed
Input schema / properties / estimator / descriptionPrevious value: -"Hedges' g corrects Cohen's d's small-sample bias by the exact J(df); Cohen's d is the uncorrected standardised difference; Glass's Δ standardises by the reference group's SD alone, for when the treatment changes the spread. Values: hedges_g (Hedges' g), cohens_d (Cohen's d), glass_delta (Glass's Δ)."New value: +"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 treatment changes the spread. Values: hedges_g (Hedges' g), cohens_d (Cohen's d), glass_delta (Glass's Δ)." - changed
Input schema / properties / pooled_sd / descriptionPrevious value: -"standardise by the pooled SD (Student). Off averages the two variances, with Welch's df. Only applies when estimator is hedges_g or cohens_d."New value: +"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." - changed
Output schema / properties / estimate / descriptionPrevious value: -"the standardised effect"New value: +"the standardized effect"
- Added
fastq_qc - Changed
find_linear_motifs1 field changed- added
Input schema / properties / speciesAdded value: +{ + "default": "", + "description": "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 that species' lineage is dropped, with its range. Empty runs no taxon filter, which is ELM's own default.", + "type": "string" +}
- Changed
fold_guide2 fields changed- added
Output schema / properties / unavailableAdded value: +{ + "description": "why nothing was folded, when no scaffold is published for this nuclease; null when the fold ran", + "type": [ + "string", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "spacer", - "sgRna", - "spacerScaffoldPairs", - "scaffoldIntact", - "scaffoldName" -]New value: +[ + "spacer", + "sgRna", + "spacerScaffoldPairs", + "scaffoldIntact", + "scaffoldName", + "unavailable" +]
- Changed
genotype_pca2 fields changed- added
Output schema / properties / explainedVarianceAdded value: +{ + "description": "the variance each reported component explains, in the data's own units (the eigenvalues)" +} - changed
Output schema / requiredPrevious value: -[ - "coords", - "explainedVarianceRatio", - "sites" -]New value: +[ + "coords", + "explainedVarianceRatio", + "explainedVariance", + "sites" +]
- Changed
infer_proteins3 fields changed- added
Output schema / properties / methodAdded value: +{ + "description": "the inference algorithm and mapping that produced these proteins, named", + "type": [ + "string", + "null" + ] +} - added
Output schema / properties / scoreColumnAdded value: +{ + "description": "the column the match scores were read from, which decides whether higher or lower is better", + "type": [ + "string", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "proteins", - "groups", - "ambiguityGroups", - "count" -]New value: +[ + "proteins", + "groups", + "ambiguityGroups", + "count", + "scoreColumn", + "method" +]
- Added
list_research_runs - Changed
plan_rnaseq_experiment2 fields changed- removed
Input schema / properties / normalisation_ratioRemoved value: -{ - "default": 1, - "description": "w, the ratio of the two groups' normalisation factors. Only applies when method is exact. Advanced.", - "minimum": 0, - "type": "number" -} - added
Input schema / properties / normalization_ratioAdded value: +{ + "default": 1, + "description": "w, the ratio of the two groups' normalization factors. Only applies when method is exact. Advanced.", + "minimum": 0, + "type": "number" +}
- Changed
propagate_uncertainty3 fields changed- added
Output schema / properties / firstOrderMeanAdded value: +{ + "description": "the expression evaluated at the input means, before the second-order correction", + "type": [ + "number", + "null" + ] +} - added
Output schema / properties / secondOrderMeanAdded value: +{ + "description": "the mean with the second-order Taylor correction applied, whether or not the reported mean uses it", + "type": [ + "number", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "propagatedMean", - "propagatedSd", - "confLower", - "confUpper", - "simulated", - "permuted", - "permPValues", - "contributions", - "gradient", - "variables" -]New value: +[ + "propagatedMean", + "firstOrderMean", + "secondOrderMean", + "propagatedSd", + "confLower", + "confUpper", + "simulated", + "permuted", + "permPValues", + "contributions", + "gradient", + "variables" +]
- Changed
quantify_dpcr2 fields changed- added
Output schema / properties / confLevelAdded value: +{ + "description": "the confidence level every interval in `rows` was computed at", + "type": [ + "number", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "rows", - "count", - "flagged", - "ciMethod", - "partitionVolumeNl", - "ratios", - "volumeModel", - "volumeCvPercent" -]New value: +[ + "rows", + "count", + "flagged", + "ciMethod", + "partitionVolumeNl", + "ratios", + "volumeModel", + "volumeCvPercent", + "confLevel" +]
- Changed
rank_tradeoffs7 fields changed- changed
Input schema / properties / crowding / descriptionPrevious value: -"how isolation along a front is measured: NSGA-II's normalised distance (each gap over the objective's range, averaged), or the raw sum of gaps in each objective's own units. Values: normalised (NSGA-II (normalised)), raw (raw gaps). Advanced."New value: +"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-II (normalized)), raw (raw gaps). Advanced." - added
Input schema / properties / orderAdded value: +{ + "default": "crowding", + "description": "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 (crowding distance), hypervolume (hypervolume contribution).", + "enum": [ + "crowding", + "hypervolume" + ], + "type": "string" +} - added
Input schema / properties / referenceAdded value: +{ + "description": "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 range. Only applies when order is hypervolume. Advanced.", + "type": "string" +} - added
Output schema / properties / hypervolumeAdded value: +{ + "description": "the objective space front 1 dominates up to the reference point (hypervolume order only)", + "type": [ + "number", + "null" + ] +} - added
Output schema / properties / orderAdded value: +{ + "description": "what ordered candidates within a front: crowding or hypervolume", + "type": [ + "string", + "null" + ] +} - added
Output schema / properties / referenceAdded value: +{ + "description": "the reference point the hypervolume was measured from, and whether it was derived (hypervolume order only)" +} - changed
Output schema / requiredPrevious value: -[ - "front", - "ranked", - "fronts", - "counts" -]New value: +[ + "front", + "ranked", + "fronts", + "counts", + "order", + "hypervolume", + "reference" +]
- Changed
relative_expression2 fields changed- added
Output schema / properties / referenceGeneAdded value: +{ + "description": "the gene every target was normalised to under delta-delta-Ct; null for the models that use none", + "type": [ + "string", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "rows", - "count", - "model", - "genes", - "groups", - "test", - "design", - "trend", - "standardPoints", - "efficiency" -]New value: +[ + "rows", + "count", + "model", + "genes", + "groups", + "test", + "design", + "trend", + "standardPoints", + "efficiency", + "referenceGene" +]
- Changed
resume_research_run2 fields changed- changed
Input schema / properties / budget_seconds / descriptionPrevious value: -"seconds this call may spend running tests: whole tests run until the budget is spent and the rest are deferred, so a long programme returns before a client's timeout and resume_research_run continues it. A test is never cut short and at least one runs per call. Unset: every test runs in this call. In s. Advanced."New value: +"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. A test is never cut short and at least one runs per call. Unset: every test runs in this call. In s. Advanced." - changed
Output schema / properties / run / descriptionPrevious value: -"the whole programme as a sealed jane.research-run file: the ledger, every corpus input pinned by SHA-256, the last attempt at each hypothesis. Pass it back to continue"New value: +"the whole program as a sealed jane.research-run file: the ledger, every corpus input pinned by SHA-256, the last attempt at each hypothesis. Pass it back to continue"
- Changed
run_discovery_programme3 fields changed- changed
Input schema / properties / budget_seconds / descriptionPrevious value: -"seconds this call may spend running tests: whole tests run until the budget is spent and the rest are deferred, so a long programme returns before a client's timeout and resume_research_run continues it. A test is never cut short and at least one runs per call. Unset: every test runs in this call. In s. Advanced."New value: +"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. A test is never cut short and at least one runs per call. Unset: every test runs in this call. In s. Advanced." - changed
Output schema / properties / report / descriptionPrevious value: -"the programme as text lines: registrations, runs, refusals, verdicts, literature queries"New value: +"the program as text lines: registrations, runs, refusals, verdicts, literature queries" - changed
Output schema / properties / run / descriptionPrevious value: -"the whole programme as a sealed jane.research-run file: the ledger, every corpus input pinned by SHA-256, the last attempt at each hypothesis. Pass it back to continue"New value: +"the whole program as a sealed jane.research-run file: the ledger, every corpus input pinned by SHA-256, the last attempt at each hypothesis. Pass it back to continue"
- Added
simulate_rnaseq_power - Changed
target_decoy_qvalues4 fields changed- added
Output schema / properties / decoysAdded value: +{ + "description": "how many decoy matches were scored; the FDR estimate stands on this count", + "type": [ + "number", + "null" + ] +} - added
Output schema / properties / targetsAdded value: +{ + "description": "how many target matches were scored", + "type": [ + "number", + "null" + ] +} - added
Output schema / properties / thresholdAdded value: +{ + "description": "the q-value cut-off `accepted` was counted at", + "type": [ + "number", + "null" + ] +} - changed
Output schema / requiredPrevious value: -[ - "q", - "fdr", - "accepted" -]New value: +[ + "q", + "fdr", + "accepted", + "threshold", + "targets", + "decoys" +]
289 tool updates
- First observed
activity_cliffs - First observed
adopt_trace_calls - First observed
align_read - First observed
align_sequences - First observed
alignment_agreement - First observed
alignment_window - First observed
analyze_melt_curves - First observed
annotate_region - First observed
antibody_antigen_contacts - First observed
antibody_isotype - First observed
antibody_liabilities - First observed
antibody_molecule - First observed
apply_feature_file - First observed
apply_variant_call - First observed
assemble_index_oligos - First observed
assemble_operon - First observed
assembly_plan_simulate - First observed
assess_small_molecule - First observed
audit_barcodes - First observed
audit_cds_annotations - First observed
auto_annotate - First observed
back_translate - First observed
bayesian_protein_inference - First observed
blast_project_sequences - First observed
blast_search - First observed
bootstrap_cq - First observed
browse_region - First observed
build_addgene_deposit - First observed
build_assembly_report - First observed
build_ena_submission - First observed
build_genbank_submission - First observed
build_tree - First observed
calculate_power - First observed
calculate_rnaseq_power - First observed
call_bases_from_trace - First observed
call_cq - First observed
call_mixed_bases_from_trace - First observed
cancel_research_run - First observed
canonical_tautomer - First observed
check_assay_decay - First observed
check_color_balance - First observed
check_golden_gate_parts - First observed
check_index_pool - First observed
check_invariants - First observed
check_manufacturability - First observed
check_methylation_block - First observed
check_primer_specificity - First observed
check_rows - First observed
check_scorpion_stem - First observed
check_value - First observed
classify_droplets - First observed
classify_grammar_part - First observed
cluster_molecules - First observed
codon_optimality - First observed
codon_table_fetch - First observed
codon_usage_analysis - First observed
codon_usage_distance - First observed
compare_constructions - First observed
compare_molecules - First observed
compare_reads_to_reference - First observed
compare_trees - First observed
consensus_from_traces - First observed
copy_number_allele_split - First observed
copy_number_compare - First observed
copy_number_findings - First observed
copy_number_loh - First observed
copy_number_mosaicism - First observed
copy_number_read - First observed
copy_number_regions - First observed
copy_number_segment - First observed
copy_number_somatic - First observed
crispr_analyze_screen - First observed
crispr_design_guides - First observed
crispr_design_library - First observed
crispr_quantify_edits - First observed
crispr_score_deephf - First observed
crispr_score_deepspcas9 - First observed
decompose_r_groups - First observed
delta_blast_smart - First observed
demultiplex_reads - First observed
describe_discovery_corpus - First observed
design_barcodes - First observed
design_bisulfite_primers - First observed
design_codehop - First observed
design_degenerate_primers - First observed
design_expression_variants - First observed
design_free_codes - First observed
design_fusion_site_primers - First observed
design_genetic_circuit - First observed
design_gibson_primers - First observed
design_hcr_probes - First observed
design_ish_probes - First observed
design_knockout_package - First observed
design_lamp_primers - First observed
design_multisite_primers - First observed
design_mutagenesis_primers - First observed
design_oligo_plate_order - First observed
design_overhang_set - First observed
design_padlock_probes - First observed
design_primer_pairs - First observed
design_primers - First observed
design_qpcr_assay - First observed
design_rbs - First observed
design_saturation_primers - First observed
design_sequencing_primers - First observed
design_split_sites - First observed
detect_trace_indel - First observed
differential_expression - First observed
digest_fragments - First observed
digest_reaction_conditions - First observed
discover_annotation_contradictions - First observed
discover_codon_outliers - First observed
discover_flag_rates - First observed
discover_gene_tree_discordance - First observed
discover_reference_concordance - First observed
discover_reference_stability - First observed
discover_site_avoidance - First observed
discover_target_validation - First observed
discover_tree_incongruence - First observed
domesticate_part - First observed
dot_plot - First observed
dot_plot_grid - First observed
draw_alignment - First observed
draw_gel - First observed
draw_trace - First observed
draw_tree - First observed
ebi_align - First observed
enumerate_protonation_states - First observed
enumerate_reaction - First observed
enzyme_collection - First observed
enzyme_cut_counts - First observed
estimate_effect_size - First observed
export_barcodes - First observed
export_construction_record - First observed
export_map_svg - First observed
export_trace - First observed
export_tree - First observed
fetch_record - First observed
filter_items - First observed
find_assemblies - First observed
find_linear_motifs - First observed
find_orfs - First observed
find_primer_snps - First observed
find_restriction_sites - First observed
find_star_sites - First observed
fold_guide - First observed
fold_rna - First observed
fragment_ions - First observed
fusion_pcr - First observed
gate_droplets - First observed
gc_content - First observed
gene_set_enrichment - First observed
gene_set_overrepresentation - First observed
generate_conformers - First observed
genotype_pca - First observed
get_construction_history - First observed
get_open_record - First observed
get_selection - First observed
gibson_assemble - First observed
golden_gate_assemble - First observed
graft_antibody_cdrs - First observed
history_protocol - First observed
humanize_antibody - First observed
infer_proteins - First observed
isotope_envelope - First observed
isotopic_composition - First observed
ligate_fragments - First observed
linkage_disequilibrium - First observed
list_databases - First observed
list_experiments - First observed
list_library - First observed
list_samples - First observed
list_sgrna_scaffolds - First observed
list_traces - First observed
list_workflow_templates - First observed
load_record - First observed
load_trace - First observed
lookup_clinical - First observed
lookup_compound - First observed
lookup_gene - First observed
lookup_omics - First observed
lookup_ontology - First observed
lookup_protein - First observed
lookup_residue_sites - First observed
lookup_variant - First observed
map_chemical_space - First observed
map_reaction_atoms - First observed
map_reads - First observed
mask_sequence - First observed
match_part_by_sequence - First observed
matched_molecular_pairs - First observed
melt_profile - First observed
melting_temperature - First observed
miqe_checklist - First observed
multiplex_pcr - First observed
notebook_cross_refs - First observed
number_antibody - First observed
optimize_sequence - First observed
pcr_amplify - First observed
peptide_mass - First observed
pick_first - First observed
plan_next_tools - First observed
plan_rnaseq_experiment - First observed
plan_thermocycler_program - First observed
population_ancestry - First observed
population_fst - First observed
population_site_stats - First observed
primer_check - First observed
propagate_uncertainty - First observed
protein_digest - First observed
protein_disorder - First observed
protein_disorder_metapredict - First observed
protein_membrane_profile - First observed
protein_profile - First observed
protein_properties - First observed
protein_signal_peptide - First observed
protein_topology - First observed
quantify_base_editing - First observed
quantify_dpcr - First observed
query_database - First observed
rank_next_tests - First observed
rank_reference_genes - First observed
rank_strategies - First observed
rank_tradeoffs - First observed
read_mgf - First observed
read_mzml - First observed
read_rdml_run - First observed
read_sequencing_qc - First observed
read_structure - First observed
read_structure_consensus - First observed
read_variant_calls - First observed
recombine - First observed
recompute_trace_quality - First observed
record_composition - First observed
record_experiment - First observed
relative_expression - First observed
remember_lab_preference - First observed
research_run_status - First observed
restore_trace_file_calls - First observed
restriction_ligate - First observed
resume_research_run - First observed
reverse_complement - First observed
rps_blast_cdd - First observed
rps_blast_smart - First observed
rpstblastn_smart - First observed
run_discovery_programme - First observed
run_gel_lane - First observed
run_gel_plate - First observed
run_workflow - First observed
save_enzyme_collection - First observed
scaffold_network - First observed
scan_intrinsic_terminators - First observed
scan_motif_sites - First observed
scan_protein_domains - First observed
scan_sigma70_promoters - First observed
scan_splice_sites - First observed
score_overhang_fidelity - First observed
score_rbs - First observed
score_spectrum - First observed
score_variant_effect - First observed
screen_contamination - First observed
screen_guides - First observed
screen_molecule_library - First observed
screen_oligo_structure - First observed
scrub_restriction_sites - First observed
search_literature - First observed
search_molecule_library - First observed
search_off_targets - First observed
search_records - First observed
select_substitution_model - First observed
simulate_taqman_curve - First observed
size_fragments - First observed
summarize_rows - First observed
survey_off_targets - First observed
target_decoy_qvalues - First observed
tide_quantify_indels - First observed
trace_raw_signal - First observed
transform_tree - First observed
translate_sequence - First observed
tree_statistics - First observed
tree_taxon_annotations - First observed
trim_reads - First observed
trim_trace - First observed
validate_gene_trait - First observed
validate_workflow - First observed
variant_call_summary - First observed
verify_construct - First observed
verify_read - First observed
write_structure_library
Related MCP Connectors
Hosted DNA/RNA/protein tools: primers, oligos, PCR, cloning, CRISPR, alignment, batch & pipelines.
90 molecular biology tools: plasmid maps, digests, primers, CRISPR, cloning, PubMed, lab notebook.
g:Profiler (University of Tartu) — functional enrichment analysis for a gene list against GO…
Verbex Lab Tools: deterministic wet-lab calculators and lab document templates, each checked.
Related MCP Servers
- AlicenseAqualityDmaintenanceEnables AI-assisted molecular biology experiment design with tools for qPCR primer design, cloning strategy optimization, TaqMan probe design, and multiplex compatibility analysis.61MIT
- AlicenseAqualityBmaintenanceMCP server offering verified bioinformatics tools for sequence utilities and statistics, backed by BioPython/scipy. Enables AI agents to perform accurate GC content, translation, ORF finding, motif scanning, and statistical tests through natural language.11MIT
- AlicenseAqualityBmaintenancePhylogenetic inference server driving IQ-TREE 2, always returning per-clade bootstrap support plus model selection, tree comparison, and alignment simulation, with detailed diagnostics like conflicting clades and model uncertainty.777 PyPIGPL 2.0
- AlicenseAqualityDmaintenanceEnables the generation, mutation, and evolution of DNA and protein sequences using various evolutionary models and phylogenetic algorithms. It supports realistic next-generation sequencing read simulation and population-level evolutionary tracking for bioinformatics research and testing.6BSD 2-Clause "Simplified"
Glama MCP Gateway
Add one secure layer between your agents and this server.