bamlss: results.bamlss.default – R documentation

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

results.bamlss.default

Compute BAMLSS Results for Plotting and Summaries

Description

The results function combines estimated parameters and/or samples with the bamlss.frame and computes the data that can be used, e.g., for creating effect plots or summary statistics. The function is usually used internally within bamlss. The object returned is of class "bamlss.results", which has a plotting method, see plot.bamlss.results.

Usage

results.bamlss.default(x, what = c("samples", "parameters"),
  grid = -1, nsamps = NULL, burnin = NULL, thin = NULL, ...)

Arguments

`x`	A `bamlss.frame` which has estimated parameters or samples. See also `bfit` and `GMCMC`.
`what`	Should the results data be prepared using estimated parameters or samples?
`grid`	Integer, sets the number of grid points for univariate functions to be used for creating results data, e.g., for plotting. This is more efficient when using data sets with a large number of unique covariate values. If negative suitable defaults are chosen.
`nsamps`	Integer, if results are computed using parameter samples, this argument controls the number of samples that should be used, e.g., if `nsamps = 100` only 100 samples with equidistant intervals are selected. Basically similar to argument `thin`.
`burnin`	Integer, sets the number of samples that should be dropped from the beginning of the MCMC chain when creating results.
`thin`	Integer, should the MCMC chain be thinned additionally?
`...`	Currently not used.

Value

An object of class "bamlss.results".

Examples

## Not run: ## Simulate data.
d <- GAMart()

## Estimate model with no results.
b <- bamlss(num ~ s(x1) + s(x2) + s(x3),
  data = d, results = FALSE)

## Compute model results
a <- results.bamlss.default(b)

## Plot results for smooth terms.
plot(a)

## End(Not run)

bamlss

Bayesian Additive Models for Location, Scale, and Shape (and Beyond)

v1.1-3

GPL-2 | GPL-3

Authors

Nikolaus Umlauf [aut, cre] (<https://orcid.org/0000-0003-2160-9803>), Nadja Klein [aut] (<https://orcid.org/0000-0002-5072-5347>), Achim Zeileis [aut] (<https://orcid.org/0000-0003-0918-3766>), Meike Koehler [ctb], Thorsten Simon [aut] (<https://orcid.org/0000-0002-3778-7738>), Stanislaus Stadlmann [ctb]

Initial release

2021-01-25