Print a family — print.frmtmb

Prints the family, its link and each distributional parameter with its link, in brms's layout: the first two lines are brms's, spacing included, and a mixture opens with Mixture and names each component with its own link.

Usage

# S3 method for class 'frmtmb_family'
print(x, links = FALSE, newline = TRUE, ...)

Arguments

x: A family.
links: TRUE also prints brms's line per distributional parameter other than mu, "Link function of 'sigma' (if predicted): log"; a character vector prints those parameters only.
newline: Print a blank line at the end, as brms does.
...: Unused; an argument given here is refused by name.

Value

x, invisibly.

Examples

print(student(), links = TRUE)
#> 
#> Family: student 
#> Link function: identity 
#> Parameters: mu (identity), sigma (log), nu (logm1)
#> Link function of 'sigma' (if predicted): log
#> Link function of 'nu' (if predicted): logm1
#> 
print(mixture(gaussian(), exponential()))
#> 
#> Mixture
#> 
#> Family: gaussian 
#> Link function: identity 
#> 
#> Family: exponential 
#> Link function: log 
#> Parameters: mu1 (identity), sigma1 (log), mu2 (log), theta1 (identity)
#>