print_table1: Convenience method to output a summary_table object as...

In nurseshealthstudy/Nurses: Convenience methods for working with Nurses Health Study data

Description

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

Usage

print_table1(summary_table, title = "**Table 1**", caption = "",
  output_file)

Arguments

summary_table	The qwraps2::summary_table 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 qwraps2::summary_table() object'. See the documentation and vignettes of that package to learn how to use qwraps2.

See Also

qwraps2::summary_table(), browseVignettes('qwraps2')

Examples

require(qwraps2)

mtcars_summaries <-
list('Miles Per Gallon' =
       list('min' = ~ min(mpg),
       'mean' = ~ mean(mpg),
       'mean &plusmn; sd' = ~ qwraps2::mean_sd(mpg),
       'max' = ~ max(mpg)),
     'Weight' =
       list('median' = ~ median(wt)),
     'Cylinders' =
       list('4 cyl: n (%)' = ~ qwraps2::n_perc0(cyl == 4),
            '6 cyl: n (%)' = ~ qwraps2::n_perc0(cyl == 6),
            '8 cyl: n (%)' = ~ qwraps2::n_perc0(cyl == 8)))

print_table1(summary_table = qwraps2::summary_table(mtcars, mtcars_summaries),
             title = '**mtcars summary table**',
             caption = 'example using mtcars')

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