format_corr_apa: Format results of a bivariate correlation

View source: R/format_strings.R

format_corr_apaR Documentation

Format results of a bivariate correlation

Description

This function takes the results of a bivariate correlation and formats it for easy markdown outputs

Usage

format_corr_apa(r, dof, p, as.markdown = T)

Arguments

r

value of correlation to be formatted

dof

degrees of freedom for the correlation

p

p-value of correlation

as.markdown

optional, indicates whether the resulting string should be formatted for markdown. Default is TRUE

Value

A formatted bivariate correlation statistic


silverer/statstring documentation built on Aug. 6, 2023, 11:48 a.m.