brms: brmsfit_needs_refit – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

brmsfit_needs_refit

Check if cached fit can be used.

Description

Checks whether a given cached fit can be used without refitting when file_refit = "on_change" is used. This function is internal and exposed only to facilitate debugging problems with cached fits. The function may change or be removed in future versions and scripts should not use it.

Usage

brmsfit_needs_refit(
  fit,
  sdata = NULL,
  scode = NULL,
  algorithm = NULL,
  silent = FALSE,
  verbose = FALSE
)

Arguments

`fit`	Old `brmsfit` object (e.g., loaded from file).
`sdata`	New Stan data (result of a call to `make_standata`). Pass `NULL` to avoid data check.
`scode`	New Stan code (result of a call to `make_stancode`). Pass `NULL` to avoid code check.
`algorithm`	New algorithm. Pass `NULL` to avoid algorithm check.
`silent`	Logical. If `TRUE`, no messages will be given.
`verbose`	Logical. If `TRUE` detailed report of the differences is printed to the console.

Details

Use with verbose = TRUE to get additional info on how the stored fit differs from the given data and code.

Value

A boolean indicating whether a refit is needed.

brms

Bayesian Regression Models using 'Stan'

v2.15.0

GPL-2

Authors

Paul-Christian Bürkner [aut, cre], Jonah Gabry [ctb], Sebastian Weber [ctb], Andrew Johnson [ctb], Martin Modrak [ctb]

Initial release

2021-03-10