print.optcheck: Print method for 'optcheck' and 'summary.optcheck' objects.

In optimCheck: Graphical and Numerical Checks for Mode-Finding Routines

Print method for optcheck and summary.optcheck objects.

Description

Print method for optcheck and summary.optcheck objects.

Usage

## S3 method for class 'optcheck'
print(x, digits = max(3L, getOption("digits") - 3L), n = 5L, ...)

## S3 method for class 'summary.optcheck'
print(x, digits = max(3L, getOption("digits") - 3L), n = 5L, ...)

Arguments

x	Object of class optcheck or summary.optcheck, currently returned by optim_proj(), optim_refit(), or a summary of either of those calls.
digits	Number of digits to display.
n	Number of elements of solution vector to display (see Details).
...	Further arguments to be passed to or from other methods.

Details

The print methods for optcheck and summary.optcheck objects both display three-column matrix, consisting of the potential solution (xsol), the absolute difference between it and the optimal solution (xopt) return by either optim_proj() and optim_refit(), and the relative difference (⁠R = (xopt - xsol)/|xsol|⁠). Only the elemnts corresponding to the top-n relative differences are displayed.

Value

Invisibly x itself.

optimCheck documentation built on Sept. 11, 2024, 6:31 p.m.