Source code for chi.library._data_library_api

#
# This file is part of the chi repository
# (https://github.com/DavAug/chi/) which is released under the
# BSD 3-clause license. See accompanying LICENSE.md for copyright notice and
# full license details.
#

import os

import pandas as pd


[docs] class DataLibrary(object): r""" A collection of Erlotinib PKPD datasets. Each method corresponds to a separate dataset, which will return the corresponding dataset in form of a :class:`pandas.DataFrame`. All dataset are organised in 9 columns: ID | Time | Time unit | Observable | Value | Observable unit | Dose | Dose unit | Duration. References ---------- .. [1] Eigenmann, M. J. et al., Combining Nonclinical Experiments with Translational PKPD Modeling to Differentiate Erlotinib and Gefitinib, Mol Cancer Ther. 2016; 15(12):3110-3119. """ def __init__(self): # Get path to data library self._path = os.path.dirname(os.path.abspath(__file__)) self._path += '/data_library/'
[docs] def lung_cancer_control_group(self): r""" Returns the lung cancer control group data published in [1]_ as a :class:`pandas.DataFrame`. The dataset contains the time series data of 8 mice with patient-derived lung cancer implants. The tumour volume of each mouse was monitored over a period of 30 days and measured a couple times a week. """ file_name = 'lxf_control_growth.csv' data = pd.read_csv(self._path + file_name) return data
[docs] def lung_cancer_high_erlotinib_dose_group(self): r""" Returns the high erlotinib dose lung cancer treatment group data published in [1]_ as a :class:`pandas.DataFrame`. The dataset contains the time series data of 6 mice with patient-derived lung cancer implants. Each mouse was treated with an oral dose of erlotinib of :math:`100\, \text{mg}` per :math:`\text{g}` body weight. The dose was administered daily from day 3 to day 16, with a treatment break on days 9 to 13. The blood plasma concentration of erlotinib was measured on day 14, while the tumour volume of each mouse was monitored over a period of 30 days and measured a couple times a week. """ file_name = 'lxf_high_erlotinib_dose.csv' data = pd.read_csv(self._path + file_name) return data
[docs] def lung_cancer_low_erlotinib_dose_group(self): r""" Returns the low erlotinib dose lung cancer treatment group data published in [1]_ as a :class:`pandas.DataFrame`. The dataset contains the time series data of 8 mice with patient-derived lung cancer implants. Each mouse was treated with an oral dose of erlotinib of :math:`6.25\, \text{mg}` per :math:`\text{g}` body weight. The dose was administered daily from day 3 to day 16. The blood plasma concentration of erlotinib was measured on day 10 and 16, while the tumour volume of each mouse was monitored over a period of 30 days and measured a couple times a week. """ file_name = 'lxf_low_erlotinib_dose.csv' data = pd.read_csv(self._path + file_name) return data
[docs] def lung_cancer_medium_erlotinib_dose_group(self): r""" Returns the medium erlotinib dose lung cancer treatment group data published in [1]_ as a :class:`pandas.DataFrame`. The dataset contains the time series data of 8 mice with patient-derived lung cancer implants. Each mouse was treated with an oral dose of erlotinib of :math:`25\, \text{mg}` per :math:`\text{g}` body weight. The dose was administered daily from day 3 to day 16. The blood plasma concentration of erlotinib was measured on day 10 and 16, while the tumour volume of each mouse was monitored over a period of 30 days and measured a couple times a week. """ file_name = 'lxf_medium_erlotinib_dose.csv' data = pd.read_csv(self._path + file_name) return data
[docs] def lung_cancer_single_erlotinib_dose_group(self): r""" Returns the single erlotinib dose lung cancer treatment group data published in [1]_ as a :class:`pandas.DataFrame`. The dataset contains the time series data of 30 mice with patient-derived lung cancer implants. Each mouse was treated with a single oral dose of erlotinib of :math:`100\, \text{mg}` per :math:`\text{g}` body weight. The dose was administered either on day 0 or day 4. The blood plasma concentration of erlotinib was measured only once per mouse, either on day 0 or day 4. """ file_name = 'lxf_single_erlotinib_dose.csv' data = pd.read_csv(self._path + file_name) return data