varMarkdown: Returns a formatted string for stats reporting in R Markdown

Description Usage Arguments Value Author(s)

View source: R/varMarkdown.R

Description

Returns a formatted string to report the B, CI, partial-eta2, t, and p-value for an effect from an lm mode. This formatted string is apporpriate for use in an R Markdown document for a dynamic report of research results.

Usage

1
varMarkdown(effect, mod, modsum, statistic='t', B=1, CI=B, pe=2)

Arguments

effect

Text label for effect from lm

mod

object returned from lm()

modsum

object returned from summary() or modelSummary()

statistic

test statistic to report: 't' or 'F'

B

number of decimal places for report of B; NULL if B should not be reported

CI

number of decimal places for report of Bs in 95 CI; NUll if CI should not be reported

pe

number of decimal places for report of partial eta2. Null if should not be reported

Value

Returns a formatted string that can be directly included in a R Markdown file for a dynamic report

Author(s)

John J. Curtin jjcurtin@wisc.edu



lmSupport documentation built on May 19, 2017, 8:16 a.m.
Search within the lmSupport package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.