Package 'midnight'

Fit Multivariate Linear Models

Description

fastLmMatrix() estimates the linear model for multivariate response using one of several methods implemented using the Eigen linear algebra library.

Usage

fastLmMatrix(x, ...)

## Default S3 method:
fastLmMatrix(x, y, tol = 1e-07, method = 0L, ...)

## S3 method for class 'formula'
fastLmMatrix(formula, data = list(), method = 0L, ...)

Arguments

x	a model matrix $X$.
...	optional parameters passed to methods.
y	the response matrix $Y$.
tol	tolerance for the rank calculation.
method	an integer with value 0 for the column-pivoted QR decomposition, 1 for the unpivoted QR decomposition, 2 for the LLT Cholesky, 3 for the LDLT Cholesky, and 4 for the Jacobi singular value decomposition (SVD). Default is zero.
formula	an object of class "formula" (or one that can be coerced to that class): a symbolic description of the model to be fitted.
data	an optional data frame, list or environment (or object coercible by as.data.frame to a data frame) containing the variables in the model.

Details

fastLmMatrix() is a performance-optimized version of the standard lm.fit() function. Unlike RcppEigen::fastLm(), it is specifically designed to handle multivariate responses ($Y$ as a matrix). It leverages the Eigen C++ template library for high-performance linear algebra, providing several decomposition methods with different trade-offs between speed and numerical stability.

Value

fastLmMatrix() returns a list with the following components:

coefficients	$p \times k$ matrix of coefficients.
fitted.values	$n \times k$ matrix of fitted values.
residuals	$n \times k$ matrix of residuals.
rank	an integer giving the numeric rank of the model matrix $X$.

See Also

lm.fit, fastLm

---

Plot MID Importance with ggplot2

Description

The midnight package extends midr::ggmid() to provide modern distribution plots for MID feature importance. Added types include sina, beeswarm, and violin plots.

Usage

## S3 method for class 'midimp'
ggmid(object, type = NULL, theme = NULL, terms = NULL, max.nterms = 30, ...)

Arguments

object	a "midimp" object to be visualized.
type	the plotting style. In addition to standard types ("barplot", "boxplot", "dotchart", "heatmap"), this extended method supports "violinplot", "sinaplot", and "beeswarm".
theme	a character string or object defining the color theme. See color.theme for details.
terms	an optional character vector specifying which terms to display.
max.nterms	an integer specifying the maximum number of terms to display. Defaults to 30.
...	optional parameters passed on to the layers.

Details

This is an S3 method for the midr::ggmid() generic for "midimp" objects created by midr::mid.importance(). This method replaces the primary layer with modern distribution geoms when type is one of the extended options.

Value

ggmid.midimp() returns a "ggplot" object.

Note

This S3 method is NOT registered automatically when the midnight package is loaded, and activated when nightfall() is explicitly called.

See Also

nightfall, mid.importance

---

Transition into and out of Midnight

Description

nightfall() activates the extended features provided by the midnight package. It overrides specific S3 methods (such as ggmid.midimp), switches the underlying solvers to highly optimized Eigen-based routines via global options, and applies midnight-themed color palettes.

daybreak() reverses these changes, restoring the default behavior, solvers, and themes of the midr package.

Usage

nightfall(methods = TRUE, solvers = TRUE, themes = TRUE)

daybreak(methods = TRUE, solvers = TRUE, themes = TRUE)

Arguments

methods	logical. If TRUE, overrides (or restores) the ggmid.midimp S3 method.
solvers	logical. If TRUE, sets (or restores) calculation solvers via options() (e.g., midr.solver.qr, midr.solver.svd). These optimized solvers can be utilized by specifying the corresponding method in interpret() (e.g., method = "qr").
themes	logical. If TRUE, applies (or restores) color themes by setting options() for midr.qualitative, midr.sequential, and midr.diverging.

Value

nightfall() and daybreak() return an invisible list containing the previous options for solvers and themes.

---

Perspective Plot of MID Effects

Description

Visualizes the combined effect of two variables from a "mid" object using a 3D perspective plot.

Usage

## S3 method for class 'mid'
persp(x, pair, ..., resolution = c(50L, 50L))

Arguments

x	a "mid" object, typically the result of midr::interpret().
pair	a character string or a character vector of length two specifying the variables to be plotted. pair = "x*y" plots the sum of the main effects and their interaction, pair = "x+y" plots the sum of the two main effects, and pair = "x:y" plots only the interaction effect. A character vector of length two (e.g., c("x", "y")) is treated as "x+y".
...	additional arguments passed on to graphics::persp().
resolution	an integer or vector of two integers specifying the resolution of the evaluation grid for the x and y axes. Defaults to c(50L, 50L).

Details

This is an S3 method for the persp() generic that plots a sum of effects for a "mid" object. The plotted effects are inferred from the pair argument.

Value

persp.mid() invisibly returns the viewing transformation matrix.

See Also

persp, plot.mid

Examples

mid <- midr::interpret(mpg ~ wt * hp + factor(am), data = mtcars, lambda = .5)

# Plot the sum of the main effects and their interaction
persp(mid, pair = "wt*hp", theta = 210, phi = 20)

# Plot only the interaction effect
persp(mid, pair = "wt:hp", theta = 210, phi = 20)

# Plot the additive main effects with a higher resolution
persp(mid, pair = "wt+hp", resolution = 100L, theta = 210, phi = 20)

---