Skip to main content

A library for processing and interpreting DNA high-resolution melt and amplification curves for the meningoencephalitis panel.

Project description



PyPCR

A Python library for processing and interpreting DNA High-Resolution Melt and Amplification Curves for the Meningoencephalitis Panel

InstallationFeaturesDocumentationHelp

PyPCR

PyPCR primarily focuses on feature extraction and interpreting results from parsed data. here the first step is to parses files into the .rex format, extracting essential information such as HRM (High Resolution Melting) data, cycle threshold (CT) values, and sample details. It facilitates feature extraction from HRM data by converting it into melt curves, and for parsed CT data, it identifies take-off points crucial for determining the severity of affected pathogens. PyPCR integrates these features to interpret results and generate comprehensive reports for respective identifiers.

Installing with PIP

python -m pip install PyPCR

or

pip3 install PyPCR

Classifiers

Development Status5 - Production/Stable
Intened AudienceHealthcare
LicenseOSI Approved :: MIT License
Operating SystemMicrosoft :: Windows :: Windows 10
Programming LanguagePython 3

Features

  1. Rextractor
    1. Extract the data from Rotor Gene Experiment(.rex) files.
      1. High Resolution Melt (HRM)
      2. Amplification Curve - Cycle Time (CT)
    2. Processing Data
      1. Filter Only MEP Pathogens
      2. Separate by patients
  2. MEP panel
    1. Feature Extraction
      1. Target – Pathogen Name
      2. Temperature (Peak of the Melt Curve)
      3. Width
      4. Prominence
      5. Take of Point
      6. Take down Point
      7. Area Under the curve
    2. Interactive Visulization.
      1. High Resolution Melt
      2. Melt Curve
      3. Amplification Curve
    3. Result
      1. Interpreting the results of the pathogens
      2. Generate report for test Results

Input Data format

The input file for the library is the run file from the Rotor-Gene machine, which is in the format of a Rotor-Gene Experiment (.rex) file, and we can directly provide the .rex file without any preprocessing.

Documentation

Importing Library

from PyPCR.Rextractor import rex_reader
from PyPCR.Mep_panel import Mep_diagnoser

PyPCR.Rextractor.rex_reader()

PyPCR.Rextractor.rex_reader(path = None)

Parameters:

path : Rotor Gene Experiment file path (.rex)

Returns:

A dictionary containing various patient ID for each separate patients: class 'dict_keys'

A dictionary containing various dataframes (HRM) for respective patient ID's: class 'dict_keys'

A dictionary containing various dataframes (CT) for respective patient ID's: class 'dict_keys'


Example

from PyPCR.Rextractor import rex_reader
Patient_ids,raw_hrm,raw_ct = rex_reader("your .rex file path")

PyPCR.Mep_panel.Mep_diagnoser

md = Mep_diagnoser()

hrm_data = md.transform_hrm(dataframe: Any,figure: bool = False)
ct_data = md.transform_ct(dataframe: Any,figure: bool = False)
melt = md.hrm_to_melt(figure: bool = False)
hrm_features = md.hrm_feature_extraction()
ct_values = md.ct_value()
md.Tm_threshold()
result = md.predict_result()
report = md.report( output_fie_path: Any,patient_id: Any)

Function Documentation

transform_hrm

Parameters:

  • dataframe: HRM data obtained from rex_reader().
  • figure (optional): Boolean flag indicating whether to generate an HRM graph.

Returns:

  • Processed HRM data.
  • If figure is True, an HRM graph is also returned.

transform_ct

Parameters:

  • dataframe: CT data acquired from rex_reader().
  • figure (optional): Boolean flag to specify if a CT graph should be produced.

Returns:

  • Processed CT data.
  • If figure is True, a CT graph is included in the output.

hrm_to_melt

Parameters:

  • figure (optional): Boolean flag for generating a melt graph.

Returns:

  • Melted data.
  • If figure is True, a melt graph is also provided.

hrm_feature_extraction

No Parameters Needed

Returns:

  • HRM features extracted from the data.

ct_value

No Parameters Needed

Returns:

  • CT values derived from the data.

predict_result

No Parameters Needed

Returns:

  • Predicted result based on the processed data.

report

Parameters:

  • output_file_path: Path to save the generated report.
  • patient_id: Identifier for the patient.

Returns:

  • Generated report based on the analysis.

Sample code Snippet for interpreting individual result

from PyPCR.Rextractor import rex_reader
from PyPCR.Mep_panel import Mep_diagnoser

# File extraction from the rex file
patient_id,hrm,ct = rex_reader("Your .rex file path")
print(patient_id)
# Create Object
md = Mep_diagnoser()

# Interpreting the results by providing patient ID manually
hrm_data = md.transform_hrm(hrm[id])
ct_data = md.transform_ct(ct[id])
melt = md.hrm_to_melt(figure: False)
hrm_features = md.hrm_feature_extraction()
ct_values = md.ct_value()
md.Tm_threshold()
result = md.predict_result()
report = md.report( output_fie_path=f"{id}.pdf",patient_id={id})

Sample code Snippet for interpreting all individual result

from PyPCR.Rextractor import rex_reader
from PyPCR.Mep_panel import Mep_diagnoser

# File extraction from the rex file
patient_id,hrm,ct = rex_reader("Your .rex file path")

# Create Object
md = Mep_diagnoser()

# Interpreting the results
for id in patient_id:
    hrm_data = md.read_hrm(hrm[id])
    ct_data = md.read_ct(ct[id])
    melt = md.hrm_to_melt(figure: False)
    hrm_features = md.hrm_feature_extraction()
    ct_values = md.ct_value()
    md.Tm_threshold()
    result = md.predict_result()
    report = md.report( output_fie_path=f"{id}.pdf",patient_id={id})

Getting Help

If you need to get in touch with the team, please contact through email address:
chandruganeshan24@gmail.com
vikramsekar2305@gmail.com

Developers

The developer of this Software are M.Sc Data Analytics Students in Department of Computer Application at Bharathiar University

Chandru G
Chandru Ganeshan
Vikram S
Vikram Sekar

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

pyPCR-0.0.1.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

pyPCR-0.0.1-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file pyPCR-0.0.1.tar.gz.

File metadata

  • Download URL: pyPCR-0.0.1.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for pyPCR-0.0.1.tar.gz
Algorithm Hash digest
SHA256 56a39c08ed679daa80d49bc6b271d526a600988ecc3360e67535923ef8e3eefd
MD5 041962bc8399cfe78920411844ce8eb1
BLAKE2b-256 b0f2e95d69acda3b889d0c5fd5ce958e07e9430622eadd5195f357cc00a142c9

See more details on using hashes here.

File details

Details for the file pyPCR-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: pyPCR-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for pyPCR-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 59b4dba5e1e0e40fdc8fe419cdfac05f3031516d04be8813141359b64d171bd1
MD5 5e35908fef907997e9e76660a9712693
BLAKE2b-256 274eedb1ba82b2325a5deece2810e882e2934b39ce67f545f934b0ab03ab15f4

See more details on using hashes here.

Supported by

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