report_r: Generate an in-text report of correlation results

In durkeepk/report: Automate Reporting of Common Statistical Analyses

Description

Generate an in-text report of correlation results

Usage

report_r(corcoef = NULL, format = "rmarkdown", inline = T)

Arguments

corcoef	object containing correlation coefficient
format	How should the output be formatted? Available options are: "plain", "latex", "rmarkdown"
inline	Should non-plain results be formatted for inline (TRUE) or for copy-pasting (FALSE)? (default is TRUE)

Value

correlation coefficient reported to three decimal places (no leading zero)

Examples

x1 <- rnorm(200, 10, 2)
x2 <- rnorm(200, 15, 1.5)
r_coef <- cor(x1, x2)
report_r(r_coef)

durkeepk/report documentation built on May 8, 2019, 11:55 a.m.