Description Usage Arguments Value
View source: R/binary_search_mcr.r
Primarily for internal use (see get_empirical_MCR
for a more user friendly wrapper function).
1 2 3 | getMCR_internal(s, precomputed, eps, tol_mcr = 2^(-20),
force_lower_0 = TRUE, warn_lower_0 = TRUE, maxiter_BS = 400,
verbose = "pb", ...)
|
s |
To search for MCR+, set 's' to 1. To search for MCR-, set 's' to -1. |
precomputed |
output from |
eps |
loss threshold on the absolute scale |
tol_mcr |
tolerance for MCR binary search |
force_lower_0 |
(TRUE is reccomended) This option can greatly reduce computation time for MCR-, and does not affect MCR+. For MCR-, setting force_lower_0=TRUE tells us to leverage fact that MR values <=1 have a similar interpretation, i.e., null reliance. If MCR- is >=1, this option setting will have no effect. If MCR- is <=1, this option setting directs us to not compute to additional precision beyond the fact that it is <=1. |
warn_lower_0 |
flags when the search stops early due to finding a well-performing model with MR < 1. As discussed above, this can occur intentionally when force_lower_0=TRUE, and is often not a problem. |
maxiter_BS |
maximum number of iterations for the binary serach. |
verbose |
either 'pb' (progress bar),'full', or other for no progress messages. |
... |
passed to |
A list containing
mcr
- the MCR value.
approximation_error_linear
- The difference between the computed bound on MCR, and the most extreme MR value found for a valid model, during the search.
approximation_error_search
- The largest possible reduction to the approximation error that could be achieved by continuing the search. This is computed based on the fact that our binary search method uses linearizations.
gam_opt
- (For internal use) final binary search parameter value.
s
- see Arguments.
full_model_output
- More detailed description of the final model identified, which will depend on the selected model class (see arguments for precompute_mcr_objects_and_functions
).
searchpath
- Output from steps of the search, used for plot_empirical_MCR_searchpath
.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.