bamlss: smooth.construct – R documentation

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

smooth.construct

Constructor Functions for Smooth Terms in BAMLSS

Description

The generic function is only a copy of smooth.construct adding a ... argument. For objects of class "bamlss.frame" and "bamlss" the method extracts all smooth model terms, see function bamlss.frame for details on the setup of BAMLSS.

Usage

## Function as in package mgcv
## but with additional dots argument.
smooth.construct(object, data, knots, ...)

## For 'bamlss.frame's.
## S3 method for class 'bamlss.frame'
smooth.construct(object, data = NULL, knots = NULL,
  model = NULL, drop = TRUE, ...)

## S3 method for class 'bamlss.formula'
smooth.construct(object, data = NULL, knots = NULL,
  model = NULL, drop = TRUE, ...)

## S3 method for class 'bamlss.terms'
smooth.construct(object, data = NULL, knots = NULL,
  model = NULL, drop = TRUE, ...)

Arguments

`object`	Either a smooth specification object, or object of class `"bamlss"`, `"bamlss.frame"`, `"bamlss.formula"` or `"bamlss.terms"`. For smooth specification objects, see function `smooth.construct`.
`data`	A data frame or list, see also see function `smooth.construct`.
`knots`	See function `smooth.construct`.
`model`	Character, specifies for which model parameter the smooth constructs should be created.
`drop`	If there is only one model parameter the returned named list is simplified.
`...`	Arguments passed to the smooth term constructor functions.

Value

For smooth specification objects see function see smooth.construct. For objects of class "bamlss.frame" or "bamlss" the list of smooth constructs, see function bamlss.frame for more details.

Examples

## Generate some data.
d <- GAMart()

## Create a "bamlss.frame".
bf <- bamlss.frame(num ~ s(x1) + s(x2), data = d)

## Extract the smooth construct.
sc <- smooth.construct(bf)
str(sc)

## Also possible with formulas.
f <- bamlss.formula(list(
  num ~ s(x1) + te(lon,lat),
  sigma ~ s(x2)
), family = "gaussian")

sc <- smooth.construct(f, data = d)
str(sc)

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