nca.urine¶
Non-compartmental analysis of urinary excretion data.
A urine study does not sample a concentration over time, it collects the urine of a subject over intervals \([s_k, e_k]\) and measures the volume and the concentration of the substance in every collection. The analysis runs on the excretion rate curve: the rate
of every collection, plotted against the midpoint \(\bar t_k = (s_k + e_k)/2\)
of its interval. The rate curve is analysed like a concentration curve
(Phoenix WinNonlin urine models 210 to 212, which mirror the plasma models 200
to 202), so the areas, the peak and the terminal regression come from the same
vectorized core as every other analysis of the package
(pkpdutils.nca.nca.compute_parameters) and only the names differ:
aurc_last is the auc_last of the rate curve, max_rate its cmax and
mid_pt_last its tlast.
The area under the rate curve is an amount, since a rate times a time is an
amount, and \(\mathrm{AURC}_{0\text{-}\infty}\) is the amount the subject would
excrete in total. What the subject did excrete over the collections is
amount_recovered, the plain sum \(A_e = \sum_k A_k\), and
percent_recovered is that amount as a percentage of the dose. With the
plasma curve of the same subject the renal clearance
follows over the same window, the one parameter Phoenix, PKanalix and Pumas all leave to the user.
Excretion
¶
Bases: BaseModel
Amounts of a substance collected over urine collection intervals.
One subject and one substance: the collection intervals \([s_k, e_k]\) with the volume of every collection and either the concentration measured in it or the amount it contains. The intervals are sorted by their start on construction, have to be strictly increasing (\(s_k < e_k\)) and may not overlap (\(e_k \le s_{k+1}\)); a gap between two collections is allowed, since a subject does not void continuously.
The amount and the concentration are two views of the same measurement and
the volume connects them, \(A_k = c_k V_k\): give either one together with
the volume and the other is derived, or give the amount alone when the
volumes were not recorded (vol_ur is then NaN). The product is taken as
it is given, so the concentration has to be in unit / volume_unit: with
unit="mg" and volume_unit="ml" it is in mg/ml, not in mg/l.
Attributes:
| Name | Type | Description |
|---|---|---|
start |
ndarray
|
start of every collection interval, in |
end |
ndarray
|
end of every collection interval, in |
unit |
str
|
unit of the amount, e.g. |
time_unit |
str
|
unit of |
volume |
ndarray | None
|
volume of every collection, in |
concentration |
ndarray | None
|
concentration in every collection, in
|
amount |
ndarray | None
|
amount in every collection, in |
volume_unit |
str | None
|
unit of |
dose |
Dose | None
|
the dose the collections follow, whose amount |
substance |
str
|
name of the substance |
label |
str | None
|
label of the subject or of the profile |
midpoint
property
¶
Midpoint \(\bar t_k = (s_k + e_k)/2\) of every collection interval.
The time the excretion rate of an interval is reported at, the convention of Phoenix WinNonlin, PKanalix, Pumas and PKNCA.
cumulative
property
¶
Amount recovered up to the end of every collection interval, \(\sum_{j \le k} A_j\).
total_amount
property
¶
Amount recovered over every collection interval, \(A_e = \sum_k A_k\).
concentration_unit
property
¶
Unit of the concentration in the collections, None without volumes.
nca_urine
¶
Non-compartmental analysis of the urinary excretion of one subject.
The excretion rate \(\dot A_k = A_k / (e_k - s_k)\) of every collection is analysed against the midpoint \(\bar t_k\) of its interval, with the same trapezoid rules and the same terminal regression as a concentration curve (Phoenix WinNonlin urine models 210 to 212): the area under the rate curve is an amount, so
and \(\lambda_z\) is the negative slope of \(\ln \dot A_k\) against
\(\bar t_k\), which is the elimination rate constant of the substance when
the renal elimination follows the plasma. The area starts at the dose
(\(t = 0\)) the way it does for a concentration curve: at 0 for an
extravascular dose, at the back-extrapolated rate of an intravenous bolus
(NCAOptions.c0_method) and at the first midpoint without a dose.
What was collected is reported as it was measured:
\(A_e = \sum_k A_k\) (amount_recovered), \(100\,A_e/D\)
(percent_recovered) and \(\sum_k V_k\) (vol_ur). With the plasma curve
of the same subject the renal clearance
is computed over the collection span, the window the amount belongs to
(EMA CPMP/EWP/QWP/1401/98 Rev. 1 asks for \(A_e\) and, where it applies,
the maximum rate; the CDISC codelist names the parameters AURC*,
RCAMINT, RCPCINT, VOLPK and RENALCL).
Only auc_method, c0_method, terminal and extrapolation_warning of
the options are read: the rules which read a concentration
(lloq, blq, kind, partial_aucs, acceptance, the uncertainty) do
not apply to a rate curve and are ignored.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
excretion
|
Excretion
|
the collections of one subject |
required |
Other Parameters:
| Name | Type | Description |
|---|---|---|
options |
NCAOptions | None
|
the options, defaults for |
plasma |
NCAResult | Timecourse | Timecourses | None
|
the plasma curve of the same subject (a |
Returns:
| Type | Description |
|---|---|
NCAResult
|
The parameters of the excretion without sample dimensions, with the |
NCAResult
|
rate curve as the point variables |
NCAResult
|
dimension |