prior_summary.blrmfit: Summarise model prior

View source: R/prior_summary.R

prior_summary.blrmfitR Documentation

Summarise model prior

Description

Extracts a summary of the prior in a structured data format.

Usage

## S3 method for class 'blrmfit'
prior_summary(object, digits = 2, ...)

Arguments

object

blrmfit (blrm_trial) object as returned from blrm_exnex (blrm_trial) analysis

digits

number of digits to show

...

ignored by the function

Details

The summary of the prior creates a structured representation of the specified prior from a blrm_exnex (blrm_trial) analysis.

Value

Returns an analysis specific list, which has it's own print function. The returned list contains arrays which represent the prior in a structured format.

Examples

## Setting up dummy sampling for fast execution of example
## Please use 4 chains and 100x more warmup & iter in practice
.user_mc_options <- options(OncoBayes2.MC.warmup=10, OncoBayes2.MC.iter=20, OncoBayes2.MC.chains=1,
                            OncoBayes2.MC.save_warmup=FALSE)

## run combo2 analysis which defines blrmfit model object
example_model("combo2", silent=TRUE)

prior_summary(blrmfit)

prior_sum  <- prior_summary(blrmfit)
names(prior_sum)

## the entries of the prior list are labelled arrays
dimnames(prior_sum$EX_mu_log_beta)

## Recover user set sampling defaults
options(.user_mc_options)


OncoBayes2 documentation built on July 26, 2023, 5:30 p.m.