Skip to main content

Standard-panel retention-index (iRT) calibration for LC-MS lipidomics feature tables (MS-DIAL / MZmine / MassCube / LipidScreener)

Project description

rt-anchor

Standard-panel retention-index (iRT) calibration for LC-MS lipidomics.

Purpose

Convert the retention time of every feature in an LC-MS table into a dimensionless, portable retention index (RI/iRT) anchored on a spiked standard panel — so retention is comparable across injections, batches, and instruments. A monotone warp is fitted from the standards and applied to all features; nothing in the original table is dropped, calibration only appends columns.

Download

pip install rt-anchor
pip install "rt-anchor[report,structures]"   # + HTML/PDF report and structure hover

Input

Required:

Input What
Sample feature table The table to calibrate. MS-DIAL / MZmine / MassCube / LipidScreener — auto-detected. Must have an m/z and a retention-time column.
Standards run A run of the standard panel (same formats) — builds the native anchor template. Required.
Polarity positive or negative.

Optional: per-injection files (per-sample tier + repeatability QC), a custom standard manifest / reference baseline, and the matching parameters (mz_tol_ppm, rt_window_min, min_anchors, extrapolate).

from rt_anchor import calibrate, write_results
res = calibrate("samples.txt", polarity="positive", standards_table="standards.txt")
write_results(res, "out/run1")
rt-anchor calibrate --samples samples.txt --standards standards.txt --polarity positive --out out/run1

Output

  • *_calibrated.csv — the original table + appended columns: RI (iRT-style index), RI_uncertainty, RI_reliability (high/medium/low/none), RI_spread, n_contributing, is_extrapolated, calibration_scope, warp_source.
  • *_model.json — the fitted warp, anchors, and QC metrics.
  • *_anchors.csv, *_log.txt — anchors used and a run log.
  • *_report.html + *_report.pdf — an interactive + static report (detection, calibration warp, repeatability). On by default; --no-report to skip.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rt_anchor-0.1.0.tar.gz (50.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rt_anchor-0.1.0-py3-none-any.whl (50.6 kB view details)

Uploaded Python 3

File details

Details for the file rt_anchor-0.1.0.tar.gz.

File metadata

  • Download URL: rt_anchor-0.1.0.tar.gz
  • Upload date:
  • Size: 50.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for rt_anchor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c550797e15276c9d97a3160fd2521e6a00c529eb09884f7c1e36ba7810fa222f
MD5 6eb2d4603ec0228c683cfda4fc7d27ba
BLAKE2b-256 8b23e58b3e656a56e569a111de8f00b04717993776c3da6a546a8e6ffb9f1c50

See more details on using hashes here.

File details

Details for the file rt_anchor-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: rt_anchor-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 50.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for rt_anchor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68a5bbf6cc1a28537da5224b2e48fa765def34164c502298c8762e399260b3e4
MD5 d1a4c4a64368eb321d3c7cfe0037ce42
BLAKE2b-256 c1d8e10d5a5424ee3ede1d845ccc10949436d313a72d6b1dd1d49e127fc09b28

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page