README.md

catsplainr

What is catsplainr?

catsplainr makes a cat translate S3 objects into text using standard templates in a simple and convenient way.

For help with the catsplainr R-package, there is a vignette available in the /vignettes folder.

Installation

The package can be installed with

install_github(c("hilaryparker/explainr", "hilaryparker/catsplainr"))

After installation, the package can be loaded into R.

library(catsplainr)

Using catsplainr

The main function in the catsplainr package is catsplain().

ptest <- prop.test(x = 500, n = 1008)
catsplain(ptest)

Bug reports

Report bugs as issues on the GitHub repository

Contributors



hilaryparker/catsplainr documentation built on May 17, 2019, 3:58 p.m.