get_peak {invivoPKfit} | R Documentation |
Find the peak of a data series
Description
Finds x- and y-value at peak y value.
Usage
get_peak(x, y, ties = "median", na.rm = TRUE, ...)
Arguments
x |
A numeric vector of 'x' data |
y |
A numeric vector of 'y' data |
ties |
As for [stats::approxfun()]: The function to apply to y-values that have the same x-value. Default ''median'‘. '’mean'' may also be useful. |
na.rm |
As for [stats::approxfun()]: How to handle missing values. Default 'TRUE' to exclude missing values from analysis. |
... |
Optional: Additional arguments which will be passed to [stats::approx()] (other than 'x', 'y', and 'xout'). |
Details
If there is more than one unique 'x' value where both 'x' and corresponding ‘y' are finite, this function calls [stats::approx()] with 'method = ’linear'', then uses [base::which.max()] to locate the maximum interpolated 'y'-value.
If there is only one unique 'x' value where both 'x' and corresponding 'y' are finite, this function calls [stats::approx()] with ‘method = ’constant'', then uses [base::which.max()] to locate the maximum interpolated 'y'-value.
If there are no unique 'x' values where both 'x' and corresponding 'y' are finite, this function returns 'NA_real_' for the peak 'x' and 'y' values.
Value
A list with two named numeric scalar components, 'x' and 'y', containing the x- and y-values at the peak.
Author(s)
Caroline Ring