API reference¶

The API reference is generated from the docstrings of the package.

pkpdutils¶

module	description
units	the unit registry of the package and unit helpers
timecourse	`Timecourse`, `Timecourses`, `Dose`, `Dosing`, `Route` and `DosingRegimen`, the data model
result	`ParameterResult`, the shared container of `NCAResult` and `FitResult`; `sample` gives a `ParameterSample`, `summary_table` the parameter table of a publication
io	exchange formats, see Data formats: `read_events`/`write_events`, `read_pknca`/`write_pknca`, `read_adnca`/`write_adnca`
cdisc	the CDISC map, see Data formats: `PKPARMCD`, `pkunit`, `to_pp`, `write_pp`
parallel	the shared worker pools: `executor`, `resolve_workers`, `split_rows`
report	`Report` and `study_report`, see Reporting: the tables and the figures of a study in one HTML or markdown document
console	shared rich console, `rich_table` and `print_table` for the tables of the package
log	logging of the package

module	description
nca.nca	`nca`, `nca_single`, `compute_parameters`: the analysis
nca.options	`NCAOptions`, `TerminalPhase`, the method enumerations and `NCAFlag`
nca.result	`NCAResult` and the units of the parameters
nca.auc	vectorized trapezoid areas, interpolation
nca.terminal	vectorized terminal phase regression
nca.intervals	parameters of every dosing interval of a multiple dose curve
nca.steady_state	steady state parameters of the last interval, accumulation ratio, superposition
nca.uncertainty	bootstrap and delta method of the parameters of group timecourses
nca.report	`M13A_STATISTICS`, `acceptability_table`, `methods_line`: the tables of a regulatory report
nca.urine	`Excretion`, `nca_urine`: the excretion rate curve, the amount recovered and the renal clearance of a urine study
nca.sparse	`nca_sparse`, `sparse_mean`, `bailer_variance`: the area of a sparse or destructive design with its standard error
nca.tss	`time_to_steady_state`, `TSSResult`: the time to steady state from the troughs of the dosing intervals
nca.bioavailability	`bioavailability`: the absolute and the relative bioavailability of two analyses
nca.analytes	`metabolite_ratio`: the metabolite to parent ratio of a batch of several analytes

module	description
fit	`fit`, `fit_timecourse`, `fit_timecourses`, `fit_table`, `FitOptions`, `FitResult`, `Model`: the engine, the result, the front ends and the options
fit.models	the model library: exponentials, the Emax family, linear, power and allometric models
fit.compare	`compare_models` and `ModelComparison`: the ranking by AICc and the Akaike weights
fit.proportionality	`proportionality_test` and `proportionality_table`: the confidence interval criterion of dose proportionality

Statistics on parameters, see Statistics.

module	description
stats	`ParameterSample`, `Scale`, `summarize`, `compare`, `multiple_comparison`, `ratio`, `ratio_table`: samples, tests and the geometric mean ratio
stats.bioequivalence	`bioequivalence`, `tost`, `Design`: the two one-sided tests, the paired, parallel, 2x2 crossover and replicate designs and the reference-scaled limits
stats.power	`power_tost`, `sample_size_tost`, `owens_q`: the power and the sample size of a study
stats.ddi	`ddi_classification`, `ddi_table`, `substrate_sensitivity`, `DDIThresholds`: the FDA and EMA classification of interactions
stats.meta	`effect_size`, `fixed_effect`, `random_effects`, `heterogeneity`, `meta_analysis`: the meta-analysis

Figures, see Plotting.

module	description
plot	`PlotStyle`, `plot_timecourse`, `plot_nca`, `plot_nca_grid`, `plot_intervals`, `plot_fit`, `plot_goodness_of_fit`, `plot_dose_proportionality`, `plot_parameters`, `plot_ratio`, `plot_forest`, `plot_bland_altman`