correlation (version 0.5.0)

display.easycormatrix: Export tables into different output formats

Description

Export tables (i.e. data frame) into different output formats. print_md() is a alias for display(format = "markdown").

Usage

# S3 method for easycormatrix
display(object, format = "markdown", digits = 2, stars = TRUE, ...)
# S3 method for easycormatrix
print_md(x, digits = 2, stars = TRUE, ...)

Arguments

object, x

An object returned by correlation() or its summary.

format

String, indicating the output format. Currently, only "markdown" is supported.

digits

To do...

stars

To do...

...

Currently not used.

Value

A character vector. If format = "markdown", the return value will be a character vector in markdown-table format.

Details

display() is useful when the table-output from functions, which is usually printed as formatted text-table to console, should be formatted for pretty table-rendering in markdown documents, or if knitted from rmarkdown to PDF or Word files.

Examples

# NOT RUN {
data(iris)
corr <- correlation(iris)
display(corr)

s <- summary(corr)
display(s)
# }