mkd_lm_results: Creates a markdown document showing the linear regression...

In freuerde/puzzle: Collection and customisation of pre-existing functions

Creates a markdown document showing the linear regression results

Description

Creates a markdown document for a (named) list of linear models (from rms::ols() or lm()) showing clearly the summary statistics and estimates in tables that can be presented.

Usage

mkd_lm_results(
  lm_list,
  dat = NULL,
  mkd_path = NULL,
  open = FALSE,
  overwrite = TRUE
)

Arguments

lm_list	A (named) list object including linear regression.
mkd_path	Path to the folder, where the markdown document should be stored. If NULL, the current path will be used.
open	Should the HTML output be opened immediately after saving? Default is FALSE.
overwrite	Should an already existing file be overwritten? Default is TRUE.

Details

This function is also used within the verif_lm() function.

Value

Save a HTML document without returning anything.

Author(s)

Dennis Freuer

freuerde/puzzle documentation built on March 27, 2022, 5:30 p.m.