Skip to main content

Crate openreadout_qpcr

Crate openreadout_qpcr 

Source
Expand description

Real-time PCR (qPCR) readers: RDML (the open interchange format, read and written), Applied Biosystems / Thermo Fisher .eds experiment documents (QuantStudio, ViiA 7, StepOne, 7500), Qiagen Rotor-Gene .rex, Roche LightCycler 480 .ixo (and LightCycler 96 .lc96p, an RDML zip with the vendor’s analysis), and the results exports of Applied Biosystems and Bio-Rad CFX software; Bio-Rad CFX .pcrd is detected and refused (it is encrypted).

Every file becomes the same normalized model (docs/formats/qpcr.md): plate runs of reactions (wells), each with the targets measured in it, the vendor-computed result (Cq, threshold, baseline window, Tm, amplification status), the amplification curve (raw and baseline-corrected fluorescence per cycle) and the melt curve. A dataset exposes:

  • table 0 results: one row per well × target (well, row, col, cq, target, sample, dye, task, quantity, …);
  • table 1 amplification and table 2 melt: the curves in long form;
  • traces: per run and dye, the amplification curves (raw and baseline-corrected), melt curves and their −dF/dT, one channel per well;
  • qpcr_report: named records and the analyses (our own Cq, ΔΔCq, standard curves).

export_rdml writes any readable file as RDML 1.3 and verifies it by reading it back.

§Example

use openreadout_core::FormatReader;
use openreadout_qpcr::{EdsReader, RdmlReader};

for r in [RdmlReader.descriptor(), EdsReader.descriptor()] {
    println!("{} ({}): .{}", r.name, r.id, r.extensions.join(", ."));
}

Structs§

CqComparison
Our Cq against the vendor’s, over every curve with a vendor result.
CqCounts
Cq statuses of a set of records.
EdsReader
Applied Biosystems / Thermo Fisher experiment documents (.eds).
ExportReader
Results exports of qPCR software: an Applied Biosystems Results table (StepOne, 7500, QuantStudio, ViiA 7 software; .xls, .xlsx, text) or a Bio-Rad CFX Quantification Cq Results table (.csv, .txt, .xlsx).
IxoReader
Roche LightCycler 480 experiment files (.ixo, an XML object stream).
PcrdReader
Bio-Rad CFX Maestro data files (.pcrd): recognised and refused (encrypted container).
QpcrAssayRecord
One well × target, with names resolved.
QpcrDataset
An opened qPCR file (RDML, .eds, .rex).
QpcrReport
Output of qpcr_report.
QpcrReportRequest
What qpcr_report returns: filters, and which analyses to run.
RdmlExportReport
What export --format rdml wrote.
RdmlReader
RDML (Real-time PCR Data Markup Language) 1.0-1.4, zipped (.rdml, .rdm) or bare XML.
RelativeQuantity
ΔΔCq relative quantification of one sample × target.
RexReader
Qiagen Rotor-Gene Q / 6000 run files (.rex, XML).
StandardCurveFit
A standard curve fitted to the standard wells of one target.
TargetCqSummary
Per-target Cq summary over the records that match the filters.

Enums§

CqMethod
How our Cq is computed (none of the methods reads the vendor’s Cq or call).

Constants§

CQ_DETERMINED
cq_status values: the vendor gave a Cq.
CQ_NO_RESULT
cq_status values: the file holds no result for this well × target (not analysed, setup only).
CQ_STATUSES
Categories of the cq_status column (codes 0, 1, 2).
CQ_UNDETERMINED
cq_status values: the vendor (or our analysis) found no amplification (“Undetermined”, RDML -1, NaN, or an SDS/7500 Ct equal to the cycle count).
EDS_FORMAT_ID
Format id of Applied Biosystems .eds experiment documents.
EXPORT_FORMAT_ID
Format id of qPCR results exports (Applied Biosystems Results tables, Bio-Rad CFX Quantification Cq Results).
IXO_FORMAT_ID
Format id of Roche LightCycler 480 .ixo experiment files.
PCRD_FORMAT_ID
Format id of Bio-Rad CFX .pcrd files (detected, not read).
RDML_FORMAT_ID
Format id of RDML files.
RDML_WRITE_VERSION
Version of RDML written.
RESULT_COLUMNS
Columns of table 0 (results), in order: one row per well × target.
REX_FORMAT_ID
Format id of Qiagen Rotor-Gene .rex files.

Functions§

default_rdml_output
Default output path: the input with .rdml (name.eds → name.rdml; an .rdml input gets name.export.rdml).
export_rdml
Write ds as RDML 1.3 to output; the file is verified by reading it back before it is renamed into place. overwrite replaces an existing output.
open_qpcr
Open a qPCR file through a registry: detection decides, so a .pcrd gets its own refusal (exit 6 with a hint) and a file of another format says what analyze qpcr reads.
qpcr_report
Records, analyses and notes for one opened file.