summary.LinCDE: summary.LinCDE

In ZijunGao/LinCDE: Conditional Density Estimation via Lindsey's Method and Boosting

summary.LinCDE

Description

This function provides relative covariate influences/importances of a LinCDE model.

Usage

## S3 method for class 'LinCDE'
summary(
  object,
  ...,
  cBars = length(object$importanceScore),
  plotit = TRUE,
  order = TRUE,
  normalize = TRUE,
  main = NULL
)

Arguments

object	a LinCDE model.
...	other parameters.
cBars	the number of bars to plot. If order=TRUE the only the variables with the cBars largest relative influence will appear in the barplot. If order=FALSE then the first cBars variables will appear in the plot. In either case, the function will return the relative influence of all of the variables.
plotit	an indicator as to whether the plot is generated.
order	an indicator as to whether the plotted and/or returned relative influences are sorted.
normalize	if TRUE then returns the normalized influence summing to 100.
main	a main title for the plot.

Value

If the object$centering is FALSE, this function returns a data frame where the first component is the variable name and the second is the computed relative influence/importance. If the object$centering is TRUE, this function returns two data frames location and beyondLocation. In each data frame, the first component is the variable name and the second is the computed relative influence/importance. The location data frame records the relative influence/importance from object$centeringModel, and the beyondLocation data frame records the relative influence/importance from the LinCDE model fitted to the residuals of object$centeringModel.

ZijunGao/LinCDE documentation built on Jan. 2, 2023, 11:14 p.m.