API reference#

The reference below documents the public objects exported from the top-level bindcurve package. Signatures, parameter descriptions, return values, and class members are generated from the source docstrings.

Data and fitting#

`bindcurve.DoseResponseData`	Validated long-form dose-response observations.
`bindcurve.FitSettings`	Settings controlling dose-response fitting.
`bindcurve.fit`	Convenience function for fitting a registered model to dose-response data.

Results and quality#

`bindcurve.FitResults`	Collection of individual fits and parameter summaries.
`bindcurve.FitResult`	Immutable result for one fitted curve.
`bindcurve.FitMetrics`	Numerical diagnostics for one fit.
`bindcurve.ParameterEstimate`	Estimate for one fitted parameter in public physical coordinates.
`bindcurve.ParameterSummary`	Summary of one native additive parameter across independent fits.
`bindcurve.ConcentrationSummary`	Summary of one positive concentration-like quantity across fits.
`bindcurve.DataQualityThresholds`	Heuristic thresholds for data-level dose-response QC.
`bindcurve.ResultQualityThresholds`	Heuristic thresholds for fit- and summary-level QC.

Plotting#

`bindcurve.CurvePoint`	Point to annotate on a fitted curve.
`bindcurve.plot_fits`	Plot observations and fitted curves for each independent experiment.
`bindcurve.plot_compounds`	Plot one summary dose-response curve per compound.
`bindcurve.plot_residuals`	Plot fit residuals against concentration on an existing axes.
`bindcurve.plot_asymptotes`	Plot model asymptotes as horizontal lines on an existing axes.
`bindcurve.plot_curve_points`	Plot arbitrary labeled points evaluated on fitted curves.

Model infrastructure#

`bindcurve.BaseDoseResponseModel`	Base class for dose-response models fitted through lmfit.
`bindcurve.ModelEvaluation`	Observable response plus any model-specific component arrays.
`bindcurve.ParameterSpec`	Complete specification for one public model parameter.
`bindcurve.get_model`	Return a registered model by name.

IC50 conversion#

`bindcurve.IC50ConversionResult`	Result of one IC50-to-Kd conversion.
`bindcurve.convert_ic50_to_kd`	Convert scalar or DataFrame IC50 values to Kd.
`bindcurve.cheng_prusoff`	Convert IC50 to Kd with the Cheng-Prusoff approximation.
`bindcurve.cheng_prusoff_corrected`	Convert IC50 to Kd with the exact Munson-Rodbard correction.
`bindcurve.coleska`	Convert IC50 to Kd with the Coleska finite-concentration correction.

Package metadata#

bindcurve.__version__ contains the installed package version.

bindcurve.__version__ = '0.1.dev1+g2e7ec87c5'#