print_model_details: Convenience method to output a model object as markdown.

Description Usage Arguments Details See Also Examples

Description

Markdown is emitted to the console, and optionally to an external file.

Usage

1
2
print_model_details(model, title = "**Model details**", caption = "",
  output_file)

Arguments

model

The model object to print.

title

The title for the table.

caption

The caption for the table.

output_file

(optional) The file to which to write the markdown.

Details

This function takes as input a model object and applies broom::tidy() to it to obtain a data frame. See the documentation and vignettes of broom for more detail.

See Also

broom::tidy(), browseVignettes('broom')

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Annette Dobson (1990) 'An Introduction to Generalized Linear Models'.
## Page 9: Plant Weight Data.
ctl <- c(4.17,5.58,5.18,6.11,4.50,4.61,5.17,4.53,5.33,5.14)
trt <- c(4.81,4.17,4.41,3.59,5.87,3.83,6.03,4.89,4.32,4.69)
group <- gl(2, 10, 20, labels = c('Ctl','Trt'))
weight <- c(ctl, trt)
test_lm <- lm(weight ~ group)

print_model_details(model = test_lm,
                    title = '**model markdown**',
                    caption = 'example using plant weight data')

nurseshealthstudy/Nurses documentation built on May 14, 2019, 3:08 a.m.