Skip to contents

Partial effects from a BoostMLR fit

Source: R/boostmlr_partial.R
boostmlr_partial.Rd

Compute partial effect surfaces for one or more covariates of a BoostMLR fit, in a form gg_boost_effect accepts.

Usage

boostmlr_partial(object, xvar.names = NULL, ...)

Arguments

object

A BoostMLR grow object, as returned by BoostMLR::BoostMLR().

xvar.names

Character vector of covariate names. Defaults to every covariate in the fit.

...

Passed to BoostMLR::partial.BoostMLR(), for example n.x, n.tm or Mopt.

Value

A boostmlr_partial object: a list with elements curves (one partial.BoostMLR() result per covariate, named by covariate), x.var.names and response.labels.

Details

BoostMLR::partial.BoostMLR() takes one covariate per call and returns a bare list with neither the covariate's name nor the responses' names, so it cannot be told apart from any other list. This wrapper calls it once per covariate with plotting switched off, and records the covariate names and the fit's response names (y_Names) alongside the results. It is the BoostMLR counterpart of boostmtree::partial.plot(output = "data").

Each result holds the raw partial effect (pList) and a lowess smooth of it over time (sList), as covariate-by-time matrices, one per response. gg_boost_effect extracts the smooth.

See also

gg_boost_effect

Examples

# \donttest{
if (requireNamespace("BoostMLR", quietly = TRUE)) {
  sim <- BoostMLR::simLong(
    n = 20, N = 3, rho = 0.8, model = 1, q_x = 2, q_y = 0
  )$dtaL
  fit <- BoostMLR::BoostMLR(
    x = sim$features, tm = sim$time, id = sim$id, y = sim$y,
    M = 50, Verbose = FALSE
  )
  plot(gg_boost_effect(boostmlr_partial(fit, "x1")))
}

# }