Diff of /man/plot.projsel.Rd [000000] .. [ede2d4]

Switch to unified view

a b/man/plot.projsel.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/projection.R
3
\name{plot.projsel}
4
\alias{plot.projsel}
5
\title{Plot of relative explanatory power of predictors}
6
\usage{
7
\method{plot}{projsel}(
8
  x,
9
  title = NULL,
10
  max.points = NULL,
11
  max.labels = NULL,
12
  from.covariates = TRUE,
13
  font.size = 12,
14
  hadj = 0.05,
15
  vadj = 0,
16
  ...
17
)
18
}
19
\arguments{
20
\item{x}{A data frame created by \code{\link[=projsel]{projsel()}}.}
21
22
\item{title}{Title of the plot. If \code{NULL}, no title is displayed.}
23
24
\item{max.points}{Maximum number of predictors to be plotted. If \code{NULL}
25
(default) or 0, all points are plotted.}
26
27
\item{max.labels}{Maximum number of predictors to be labelled. If \code{NULL}
28
(default), all predictor labels present in \code{x} are displayed, which
29
may result in overprinting.}
30
31
\item{from.covariates}{Whether the plotting should start from the unpenalized
32
covariates (\code{TRUE} by default). If set to \code{FALSE}, the plot includes a
33
point for the null (intercept-only) model.}
34
35
\item{font.size}{Size of the textual elements (labels and axes).}
36
37
\item{hadj, vadj}{Horizontal and vertical adjustment for the labels.}
38
39
\item{...}{Currently ignored.}
40
}
41
\value{
42
A \strong{ggplot2} object showing the relative incremental contribution of each
43
predictor starting from the initial set of unpenalized covariates.
44
}
45
\description{
46
The function plots the relative explanatory power of each predictor in order
47
of selection. The relative explanatory power of predictors is computed
48
according to the KL divergence from the full model to each submodel, scaled
49
in such a way that the baseline model (either the null model or the model
50
containing only unpenalized covariates) is at 0, while the full model is at 1.
51
}