rtMod-methods: 'rtMod' S3 methods

rtMod-methodsR Documentation

rtMod S3 methods

Description

S3 methods for rtMod class. Excludes functions print and plot defined within the rtMod class itself.

Get coefficients or relative variable importance for rtMod object

Usage

## S3 method for class 'rtMod'
print(x, ...)

## S3 method for class 'rtMod'
fitted(object, ...)

## S3 method for class 'rtMod'
predict(object, newdata, trace = 0, verbose = TRUE, ...)

## S3 method for class 'rtMod'
residuals(object, ...)

## S3 method for class 'rtMod'
plot(x, estimate = NULL, theme = rtTheme, filename = NULL, ...)

## S3 method for class 'rtMod'
summary(
  object,
  plots = TRUE,
  cex = 1,
  fit.true.line = "lm",
  resid.fit.line = "gam",
  fit.legend = TRUE,
  se.fit = TRUE,
  single.fig = TRUE,
  summary = TRUE,
  theme = rtTheme,
  title.col = NULL,
  ...
)

## S3 method for class 'rtMod'
coef(object, verbose = TRUE, ...)

## S3 method for class 'rtModLite'
predict(object, newdata, ...)

Arguments

x

rtMod object

...

Additional argument passed to predict(object)

object

rtModLite object

newdata

Testing set features

trace

Integer: Set trace level

verbose

Logical: If TRUE, output messages to console

estimate

Character: "fitted" or "predicted"

theme

Character: theme to use. Options: "box", "darkbox", "light", "dark"

filename

Character: Path to file to save plot

plots

Logical: If TRUE, print plots. Default = TRUE

cex

Float: Character expansion factor

fit.true.line

rtemis algorithm to use for fitted vs. true line Options: select_learn()

resid.fit.line

rtemis algorithm to use for residuals vs. fitted line. Options: select_learn()

fit.legend

Logical: If TRUE, print fit legend. Default = TRUE

se.fit

Logical: If TRUE, plot 2 * standard error bands. Default = TRUE

single.fig

Logical: If TRUE, draw all plots in a single figure. Default = TRUE

summary

Logical: If TRUE, print summary. Default = TRUE

title.col

Color for main title

Author(s)

E.D. Gennatas


egenn/rtemis documentation built on April 24, 2024, 6:58 p.m.