Skip to main content


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

Release files for PyPCR 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for PyPCR 0.0.3
File Size Uploaded
pyPCR-0.0.3.tar.gz 631.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for PyPCR 0.0.3
File Interpreter ABI Platform
pyPCR-0.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 1.3 MB

Release files / pyPCR-0.0.3.tar.gz

Download URL pyPCR-0.0.3.tar.gz
Size 631.3 kB
Tags Source
SHA-256 checksum
How to use checksums
8680531f1cdddf2f502443ce01f91a697572f09420c636cfb07982f60b6f736b
BLAKE2b-256 checksum
How to use checksums
1f2c262742b545439305e27aab439b66ddf6000381ff7ed4ef7242a685a4e291
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.4

Release files / pyPCR-0.0.3-py3-none-any.whl

Download URL pyPCR-0.0.3-py3-none-any.whl
Size 656.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9ec67c65e312abe67e6c0595fadfb5a43d31ad1c6921a50ad81304f329e98f25
BLAKE2b-256 checksum
How to use checksums
3a7364a182a7b36d2ccb7cd8dfc6bb2a2845620a6e325e262966f1a78241bf9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.4

Release history Release notifications | RSS feed

This release

0.0.3 This release

2 release files

0.0.2

3 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page