arg_check_index_plot_lm

Check arguments of residual_plot.lm

internal

Simplifies aspects of linear regression analysis, particularly simultaneous inference. Additionally, supports "A Progressive Introduction to Linear Models" by Joshua French (<https://jfrench.github.io/LinearRegression/>).

Joshua French

api2lm

Functions and Data Sets for the Book "A Progressive Introduction
to Linear Models"

arg_check_index_plot_lm function

<dl><dt>model</dt>
<dd>A fitted model object from the
<code><a href="/link/lm?package=api2lm&version=0.2" data-mini-rdoc="api2lm::lm">lm</a></code> function.</dd>
<dt>stat</dt>
<dd>A function that can be applied to an <code>lm</code>
object and returns a vector of observations for each
observation used to fit the model.</dd>
<dt>id_n</dt>
<dd>The number of points to identify with labels.
The default is <code>3</code>.</dd>
<dt>add_reference</dt>
<dd>A logical value indicating whether a
reference line should be added. The default is
<code>TRUE</code>.</dd>
<dt>text_arglist</dt>
<dd>Additional arguments passed to the
<code><a href="/link/text?package=api2lm&version=0.2" data-mini-rdoc="api2lm::text">text</a></code> function, which is used to
display the points that are identified.</dd>
<dt>abline_arglist</dt>
<dd>A named list specifying additional
arguments passed to the <code><a href="/link/abline?package=api2lm&version=0.2" data-mini-rdoc="api2lm::abline">abline</a></code>
function for the horizontal reference line added to the
plot.</dd>
<dt>extendrange_f</dt>
<dd>Positive number(s) specifying the
fraction by which the range of the residuals should be
extended using the <code><a href="/link/extendrange?package=api2lm&version=0.2" data-mini-rdoc="api2lm::extendrange">extendrange</a></code>
function. If longer than one, <code>f[1]</code> is used on
the left and <code>f[2]</code> on the right.</dd></dl>

Arguments

Check arguments of residual_plot.lm — arg_check_index_plot_lm

<dl>

<dt>model</dt>
<dd>A fitted model object from the
<code><a href='https://rdrr.io/r/stats/lm.html'>lm</a></code> function.</dd>


<dt>stat</dt>
<dd>A function that can be applied to an <code>lm</code>
object and returns a vector of observations for each
observation used to fit the model.</dd>


<dt>id_n</dt>
<dd>The number of points to identify with labels.
The default is <code>3</code>.</dd>


<dt>add_reference</dt>
<dd>A logical value indicating whether a
reference line should be added. The default is
<code>TRUE</code>.</dd>


<dt>text_arglist</dt>
<dd>Additional arguments passed to the
<code><a href='https://rdrr.io/r/graphics/text.html'>text</a></code> function, which is used to
display the points that are identified.</dd>


<dt>abline_arglist</dt>
<dd>A named list specifying additional
arguments passed to the <code><a href='https://rdrr.io/r/graphics/abline.html'>abline</a></code>
function for the horizontal reference line added to the
plot.</dd>


<dt>extendrange_f</dt>
<dd>Positive number(s) specifying the
fraction by which the range of the residuals should be
extended using the <code><a href='https://rdrr.io/r/grDevices/extendrange.html'>extendrange</a></code>
function. If longer than one, <code>f[1]</code> is used on
the left and <code>f[2]</code> on the right.</dd>

</dl>

arg_check_index_plot_lm: Check arguments of residual_plot.lm

Description

Usage

Arguments