Learn R Programming

qbrms (version 1.0.1)

print.qbrms_prior_build: Print method for qbrms_prior_build objects

Description

Nicely formats the result of prior_build_from_beliefs(), showing the elicited beliefs, implied prior distributions, and (optionally) the corresponding prior code.

Usage

# S3 method for qbrms_prior_build
print(
  x,
  digits = 3,
  show_data = FALSE,
  show_code = TRUE,
  code_object_name = "priors",
  max_terms = 12,
  ...
)

Value

Invisibly returns the input object x.

Arguments

x

An object of class "qbrms_prior_build" as returned by prior_build_from_beliefs.

digits

Integer scalar giving the number of decimal places to display for numeric summaries (default: 3).

show_data

Logical; if TRUE, print a compact summary of the elicitation data used to construct the priors.

show_code

Logical; if TRUE, print the corresponding prior code that can be copied into a modelling script.

code_object_name

Character string giving the name that will be used for the prior object in the displayed code (default: "priors").

max_terms

Integer scalar giving the maximum number of individual terms to display before truncating the printed output (default: 12).

...

Currently ignored. Included for method compatibility.