check_required_status.pk {invivoPKfit} | R Documentation |
Check required status
Description
Check whether a [pk()] object has a particular required status level
Usage
## S3 method for class 'pk'
check_required_status(obj, required_status, ...)
Arguments
obj |
A [pk()] object |
required_status |
Integer: The required status. 1 = initialized; 2 = pre-processed; 3 = pre-fitted; 4 = fitted. |
... |
Additional arguments. Not in use. |
Details
This is a helper function to check whether a [pk()] object has the status required for certain operations. For example, status 4 (fitting complete) is required for any fit evaluation functions: [predict.pk()], [residuals.pk()], [coef.pk()], [coef_sd.pk()], [rmse.pk()], [fold_error.pk()]
Value
If the [pk()] object has the required status or greater, returns TRUE. If the [pk()] object has less than the required status, returns FALSE. Returned value has an attribute 'msg', containing an informative message as a string.
Author(s)
Caroline Ring
[Package invivoPKfit version 2.0.1 Index]