iterPrintControl: Control iteration-time print formatting

In nlmixr2est: Nonlinear Mixed Effects Models in Population PK/PD, Estimation Routines

Control iteration-time print formatting

Description

Bundles the options controlling the iteration progress output emitted by 'nlmixr2' estimators. Pass as the 'print' argument to any '*Control()' function; the scalar form ('print = N') still works and is wrapped into an 'iterPrintControl()' internally.

Usage

iterPrintControl(
  every = 1L,
  ncol = NULL,
  headerEvery = NULL,
  useColor = NULL,
  simple = FALSE
)

Arguments

every	Integer. Print one iteration row every 'every' parameter evaluations; '0' suppresses output. Defaults to '1L'.
ncol	Integer or 'NULL'. Parameter columns per row before wrapping. 'NULL' (default) uses 'floor((getOption("width") - 23) / 12)'.
headerEvery	Integer or 'NULL'. Re-emit the column header every 'headerEvery' parameter-print events; '0' prints it once at fit start. 'NULL' (default) uses '10L'.
useColor	Logical (or 'NULL') emit ANSI bold/color escapes in the iteration print. 'NULL' (default) defers to [crayon::has_color()].
simple	Logical. When 'TRUE', print a single row per iteration, suppressing the unscaled ('U') / back-transformed ('X') rows. Defaults to 'FALSE'.

Value

A list with the validated, defaulted iteration-print options. Has class '"iterPrintControl"' so the outer '*Control()' functions can distinguish a pre-built object from a scalar 'print = N'.

Author(s)

Bill Denney, Matthew L. Fidler

Examples

iterPrintControl()
iterPrintControl(every = 5, headerEvery = 0)

nlmixr2est documentation built on Aug. 5, 2026, 1:11 a.m.