inlabru log message methods — bru_log

Resets the inlabru log object

Retrieve, add, and/or print log messages

Usage

bru_log_reset()

bru_log_get(pretty = FALSE)

bru_log_message(
  ...,
  domain = NULL,
  appendLF = TRUE,
  verbosity = 1,
  allow_verbose = TRUE,
  verbose = NULL,
  verbose_store = NULL
)

bru_log(txt, verbose = NULL)

bru_log_active(activation = NULL)

Arguments

pretty: logical; If TRUE, return a single string with the log messages separated and terminated by line feeds, suitable for cat(...). If FALSE, return the raw log as a vector of strings, suitable for cat(..., sep = "\n"). Default: FALSE
...: Zero or more objects passed on to base::.makeMessage()
domain: Domain for translations, passed on to base::.makeMessage()
appendLF: logical; whether to add a newline to the message. Only used for verbose output.
verbosity: numeric value describing the verbosity level of the message
allow_verbose: Whether to allow verbose output. Must be set to FALSE until the options object has been initialised.
verbose: logical; if TRUE, print the log message on screen with message(txt). Default: bru_options_get("bru_verbose")
verbose_store: Same as verbose, but controlling what messages are stored in the global log object. Can be controlled via the bru_verbose_store with bru_options_set().
txt: character; log message.
activation: logical; whether to activate (TRUE) or deactivate (FALSE) the inlabru logging system. Default: NULL, to keep the current activation state

Value

bru_log_get RETURN_VALUE

bru_log_message OUTPUT_DESCRIPTION

bru_log invisibly returns the added log message.

bru_log_active returns the previous activation state

Details

bru_log_reset() clears the log contents.

bru_log_message DETAILS

The log message is stored if the log is active, see bru_log_active()

Author

Fabian E. Bachl bachlfab@gmail.com and Finn Lindgren finn.lindgren@gmail.com

Examples

if (FALSE) {
if (interactive()) {
  # EXAMPLE1
}
}
if (FALSE) {
if (interactive()) {
  # EXAMPLE1
}
}
code_runner <- function() {
  oa <- bru_log_active(TRUE)
  on.exit(bru_log_active(oa))
  bru_log("Test message")
}
bru_log_active()
#> [1] Inf
code_runner()
cat(bru_log_get())
#> 2023-03-16 12:55:46: inlabru loaded 2023-03-16 12:55:46: Clear override options 2023-03-16 12:55:51: iinla: Evaluate component inputs 2023-03-16 12:55:51: iinla: Evaluate component linearisations 2023-03-16 12:55:51: iinla: Evaluate component simplifications 2023-03-16 12:55:51: iinla: Evaluate predictor linearisation 2023-03-16 12:55:51: iinla: Construct inla stack 2023-03-16 12:55:51: iinla: Model initialisation completed 2023-03-16 12:55:51: iinla: Iteration 1 [max:1] 2023-03-16 12:55:52: iinla: Evaluate component inputs 2023-03-16 12:55:52: iinla: Evaluate component linearisations 2023-03-16 12:55:52: iinla: Evaluate component simplifications 2023-03-16 12:55:52: iinla: Evaluate predictor linearisation 2023-03-16 12:55:52: iinla: Construct inla stack 2023-03-16 12:55:52: iinla: Model initialisation completed 2023-03-16 12:55:52: iinla: Iteration 1 [max:10] 2023-03-16 12:55:53: iinla: |lin1-lin0| = 506.3
#>        <eta-lin1,delta>/|delta| = 0
#>        |eta-lin0 - delta <delta,eta-lin0>/<delta,delta>| = 0 2023-03-16 12:55:53: iinla: Evaluate component linearisations 2023-03-16 12:55:53: iinla: Evaluate predictor linearisation 2023-03-16 12:55:53: iinla: Iteration 2 [max:10] 2023-03-16 12:55:54: iinla: |lin1-lin0| = 6.041e-07
#>        <eta-lin1,delta>/|delta| = 2.29e-15
#>        |eta-lin0 - delta <delta,eta-lin0>/<delta,delta>| = 2.937e-14 2023-03-16 12:55:54: iinla: Evaluate component linearisations 2023-03-16 12:55:54: iinla: Evaluate predictor linearisation 2023-03-16 12:55:54: iinla: Max deviation from previous: 0.138% of SD [stop if: <1%] 2023-03-16 12:55:54: iinla: Convergence criterion met, running final INLA integration with known theta mode. 2023-03-16 12:55:54: iinla: Iteration 3 [max:10] 2023-03-16 12:55:54: iinla: Evaluate component inputs 2023-03-16 12:55:54: iinla: Evaluate component linearisations 2023-03-16 12:55:54: iinla: Evaluate component simplifications 2023-03-16 12:55:55: iinla: Evaluate predictor linearisation 2023-03-16 12:55:55: iinla: Construct inla stack 2023-03-16 12:55:55: iinla: Model initialisation completed 2023-03-16 12:55:55: iinla: Iteration 1 [max:10] 2023-03-16 12:55:55: iinla: Step rescaling: 61.8%, Contract 2023-03-16 12:55:55: iinla: Step rescaling: 38.2%, Contract 2023-03-16 12:55:55: iinla: Step rescaling: 27.28%, Optimisation 2023-03-16 12:55:55: iinla: |lin1-lin0| = 597.4
#>        <eta-lin1,delta>/|delta| = -338.9
#>        |eta-lin0 - delta <delta,eta-lin0>/<delta,delta>| = 184.3 2023-03-16 12:55:55: iinla: Step rescaling: 27.3% 2023-03-16 12:55:55: iinla: Evaluate component linearisations 2023-03-16 12:55:55: iinla: Evaluate predictor linearisation 2023-03-16 12:55:55: iinla: Iteration 2 [max:10] 2023-03-16 12:55:56: iinla: Step rescaling: 99.6%, Optimisation 2023-03-16 12:55:56: iinla: |lin1-lin0| = 385.7
#>        <eta-lin1,delta>/|delta| = -1.925
#>        |eta-lin0 - delta <delta,eta-lin0>/<delta,delta>| = 19.2 2023-03-16 12:55:56: iinla: Step rescaling: 99.6% 2023-03-16 12:55:56: iinla: Evaluate component linearisations 2023-03-16 12:55:56: iinla: Evaluate predictor linearisation 2023-03-16 12:55:56: iinla: Max deviation from previous: 80400% of SD [stop if: <1%] 2023-03-16 12:55:56: iinla: Iteration 3 [max:10] 2023-03-16 12:55:57: iinla: Step rescaling: 162%, Expand 2023-03-16 12:55:57: iinla: Step rescaling: 100%, Overstep 2023-03-16 12:55:57: iinla: Step rescaling: 101.7%, Optimisation 2023-03-16 12:55:57: iinla: |lin1-lin0| = 19.3
#>        <eta-lin1,delta>/|delta| = -4.563e-05
#>        |eta-lin0 - delta <delta,eta-lin0>/<delta,delta>| = 0.02678 2023-03-16 12:55:57: iinla: Step rescaling: 102% 2023-03-16 12:55:57: iinla: Evaluate component linearisations 2023-03-16 12:55:57: iinla: Evaluate predictor linearisation 2023-03-16 12:55:57: iinla: Max deviation from previous: 896% of SD [stop if: <1%] 2023-03-16 12:55:57: iinla: Iteration 4 [max:10] 2023-03-16 12:55:57: iinla: Step rescaling: 162%, Expand 2023-03-16 12:55:57: iinla: Step rescaling: 100%, Overstep 2023-03-16 12:55:57: iinla: Step rescaling: 100%, Optimisation 2023-03-16 12:55:57: iinla: |lin1-lin0| = 0.02676
#>        <eta-lin1,delta>/|delta| = 2.929e-10
#>        |eta-lin0 - delta <delta,eta-lin0>/<delta,delta>| = 1.687e-07 2023-03-16 12:55:57: iinla: Evaluate component linearisations 2023-03-16 12:55:58: iinla: Evaluate predictor linearisation 2023-03-16 12:55:58: iinla: Max deviation from previous: 14.9% of SD [stop if: <1%] 2023-03-16 12:55:58: iinla: Iteration 5 [max:10] 2023-03-16 12:55:58: iinla: Step rescaling: 100%, Optimisation 2023-03-16 12:55:58: iinla: |lin1-lin0| = 3.007e-06
#>        <eta-lin1,delta>/|delta| = -2.607e-14
#>        |eta-lin0 - delta <delta,eta-lin0>/<delta,delta>| = 4.686e-12 2023-03-16 12:55:58: iinla: Evaluate component linearisations 2023-03-16 12:55:58: iinla: Evaluate predictor linearisation 2023-03-16 12:55:58: iinla: Max deviation from previous: 0.00109% of SD [stop if: <1%] 2023-03-16 12:55:58: iinla: Convergence criterion met, running final INLA integration with known theta mode. 2023-03-16 12:55:58: iinla: Iteration 6 [max:10] 2023-03-16 12:56:02: Test message
bru_log_active()
#> [1] Inf