calipytion

πŸ§‘β€πŸ”¬ Tool for managing and analyzing data from calibration measurements for subsequent concentration calculaton

https://github.com/fairchemistry/calipytion

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • βœ“
    CITATION.cff file
    Found CITATION.cff file
  • βœ“
    codemeta.json file
    Found codemeta.json file
  • βœ“
    .zenodo.json file
    Found .zenodo.json file
  • β—‹
    DOI references
  • β—‹
    Academic publication links
  • β—‹
    Academic email domains
  • β—‹
    Institutional organization owner
  • β—‹
    JOSS paper metadata
  • β—‹
    Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary

Keywords

biology calibration chemistry data enzymeml fair standard-curve
Last synced: 6 months ago · JSON representation ·

Repository

πŸ§‘β€πŸ”¬ Tool for managing and analyzing data from calibration measurements for subsequent concentration calculaton

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 1
  • Releases: 0
Topics
biology calibration chemistry data enzymeml fair standard-curve
Created over 3 years ago · Last pushed 7 months ago
Metadata Files
Readme Citation

Readme.md

CaliPytion - Tool to create, apply, and document calibration models for concentration calculation

Documentation Tests PyPI - Version

Overview

CaliPytion is a Python package for the creation, application, and documentation of calibration models for concentration calculations from a measured standard. This package allows for comparing different calibration models and selecting the best one based on various statistical metrics like R2, AIC, or RMSD. The selected model can then calculate the concentration of unknown samples from their measured signals. Furthermore, the calibration standard containing the calibration model and information on the used substance and measurement conditions can be exported in JSON and AnIML format for reuse and documentation.

Key Functionalities

  • πŸ“ˆ Model Fitting and Visualization:
    Automatically fits different polynomial models to the data and provides interactive plots for visually comparing these models.
  • 🎯 Model Selection:
    After fitting, a model overview is generated, allowing the user to select the best model based on the desired metric.
  • 🚷 Avoid Extrapolation:
    It prevents the use of models outside the calibrated concentration range. However, by user choice, the model can be extrapolated to calculate concentrations outside the calibration range.
  • πŸ§ͺ Compatible with EnzymeML Documents:
    CaliPytion can be used to convert the measured signals of an EnzymeML document into concentrations.
  • πŸ“‚ FAIR Data:
    Calibration models are stored together with the standard data. Constituting a complete record of the calibration process, this data can be saved as a JSON or AnIML file.

Installation

CaliPytion can be installed via pip:

bash pip install calipytion

or directly from the source code:

bash pip install git+https://github.com/FAIRChemistry/CaliPytion.git

Minimal Example

```python from calipytion import Calibrator

standard data

concentrations = [0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5] absorption = [0, 0.489, 1.056, 1.514, 1.988, 2.462, 2.878, 3.156]

unknown data

unknowns = [0.3, 1, 1.345]

initialize the calibrator

calibrator = Calibrator( moleculeid="s0", moleculename="ABTS", conc_unit="mmol / l", concentrations=concentrations, signals=absorption, )

fit and visualize model

calibrator.fit_models() calibrator.visualize()

choose cubic model

cubicmodel = calibrator.getmodel("cubic")

calculate concentrations

print(calibrator.calculateconcentrations(cubicmodel, unknowns))

-> [0.30018883573518623, 0.9823197194444907, 1.3193203297973393]

```

Model Overview

| Model Name | AIC | R squared | RMSD | Equation | Relative Parameter Standard Errors | |----------------|---------|---------------|-----------|-----------------------------------|------------------------------------------| | cubic | -56 | 0.9996 | 0.0205 | a * s0 + b * s0**2 + c * s0**3 | a: 4.6%, b: 67.4%, c: 33.6% | | quadratic | -49 | 0.9991 | 0.0318 | a * s0 + b * s0**2 + c | a: 4.0%, b: 20.0%, c: 115.2% | | linear | -37 | 0.9929 | 0.0891 | a * s0 | a: 1.7% |

image

Owner

  • Name: FAIR Chemistry
  • Login: FAIRChemistry
  • Kind: organization
  • Email: fairchemistry@ibtb.uni-stuttgart.de
  • Location: Germany

FAIR research data management in chemistry.

Citation (CITATION.cff)

cff-version: 1.2.0
title: CaliPytion
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Max
    family-names: HΓ€ussler
    email: max.haeussler@ibtb.uni-stuttgart.de
    affiliation: >-
      Institute of Technical Biochemistry and Technical
      Biochemistry, University of Stuttgart
    orcid: 'https://orcid.org/0000-0001-7306-7503'
repository-code: 'https://github.com/FAIRChemistry/CaliPytion'
url: 'https://fairchemistry.github.io/CaliPytion/'
abstract: >-
  CaliPytion is a Python tool designed for analyzing the
  relationship between measured signals and concentrations
  using various calibration models. It operates on the
  Standard data model, contining data of calibration
  measurements and their respective conditions.
keywords:
  - calibration
license: MIT
commit: 304fbf276f7c7275584b817ca5318eff63198473
version: 0.0.3
date-released: '2024-02-13'

GitHub Events

Total
  • Delete event: 6
  • Push event: 37
  • Pull request event: 20
  • Create event: 10
Last Year
  • Delete event: 6
  • Push event: 37
  • Pull request event: 20
  • Create event: 10

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 27
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 days
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.04
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 19
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • haeussma (1)
Pull Request Authors
  • haeussma (19)
  • torogi94 (7)
  • JR-1991 (2)
Top Labels
Issue Labels
documentation (1)
Pull Request Labels

Dependencies

setup.py pypi
  • sdRDM *
.github/workflows/generate_api.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
requirements.txt pypi
  • ipython *
  • lmfit *
  • matplotlib *
  • numpy *
  • pandas *
  • pydantic ==1.8.2
  • scipy *
  • setuptools *