compareGroups (version 3.3)

export2md: Exporting descriptives table to Markdown format

Description

This function takes the result of createTable and exports the tables to markdown format. It may be useful when inserting R code chunks in a Markdown file (.Rmd).

Usage

export2md(x, which.table="descr", nmax = TRUE, header.labels = c(), 
          caption = NULL, ...)

Arguments

x

an object of class 'createTable'.

which.table

character indicating which table is printed. Possible values are 'descr' or 'avail'(partial matching allowed), exporting descriptives by groups table or availability data table, respectively. Default value is 'descr'.

nmax

logical, indicating whether to show the number of subjects with at least one valid value across all row-variables. Default value is TRUE.

header.labels

see the 'header.labels' argument from createTable.

caption

character specifying the table caption for descriptives and available data table. If which.table='both' the first element of 'caption' will be assigned to descriptives table and the second to available data table. If it is set to "", no caption is inserted. Default value is NULL, which writes 'Summary descriptives table by groups of 'y'' for descriptives table and 'Available data by groups of 'y'' for the available data table.

…

currently ignored.

Value

It does not return anything, but the Markdown code to generate the descriptive or available table is printed.

See Also

createTable, export2latex, export2pdf, export2csv, export2html, export2word

Examples

# NOT RUN {
# }
# NOT RUN {
require(compareGroups)
data(regicor)
res <- compareGroups(sex ~. -id-todeath-death-tocv-cv, regicor)
export2md(createTable(res, hide.no = 'no'))
# }
# NOT RUN {
# }