waltlabtools.read_quanterix module

Functions for reading in data from Quanterix instruments.

This module provides tools for interacting with a Quanterix Simoa HD-X Analyzer.

In addition to the dependencies for waltlabtools, waltlabtools.read_quanterix also requires pandas 0.25 or greater.

The public functions in waltlabtools.read_quanterix can be accessed via, e.g.,

import waltlabtools as wlt  # waltlabtools main functionality
import waltlabtools.read_quanterix  # for Quanterix data

subset_data = wlt.read_quanterix.run_history()  # read run history

if also using other functionality from the waltlabtools package, or

from waltlabtools import read_quanterix  # for Quanterix data

subset_data = read_quanterix.run_history()  # read run history

if using only the waltlabtools.read_quanterix module.


run_history(filepath=None, drop_cols='blank') pandas.core.frame.DataFrame[source]

Reads in a Quanterix HD-X Run History file.

Parameters
  • filepath (str, path object or file-like object, optional) -- The path to the Run History CSV file. Any valid string path is acceptable. The string could be a URL. Valid URL schemes include http, ftp, s3, gs, and file. Can also be any os.PathLike or any object with a read() method. If not provided, a tkinter.filedialog opens, prompting the user to select a file.

  • drop_cols ({"blank", "uniform", "keep"}, default "blank") -- Should any columns be automatically dropped from the input file? Options:

    • "blank" : Drop all columns that are blank.

    • "uniform" : Drop all columns that have the same value for all rows, which includes blank columns.

    • "keep" : Do not drop any columns.

Returns

table (pandas.DataFrame) -- Run History.

sample_results(filepath=None, drop_cols='blank') pandas.core.frame.DataFrame[source]

Reads in a Quanterix HD-X Sample Results Report file.

Parameters
  • filepath (str, path object or file-like object, optional) -- The path to the Run History CSV file. Any valid string path is acceptable. The string could be a URL. Valid URL schemes include http, ftp, s3, gs, and file. Can also be any os.PathLike or any object with a read() method. If not provided, a tkinter.filedialog opens, prompting the user to select a file.

  • drop_cols ({"blank", "uniform", "keep"}, default "blank") -- Should any columns be automatically dropped from the input file? Options:

    • "blank" : Drop all columns that are blank.

    • "uniform" : Drop all columns that have the same value for all rows, which includes blank columns.

    • "keep" : Do not drop any columns.

Returns

table (pandas.DataFrame) -- Sample Results Report.