No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 2e4863a Apr 27, 2017

README.md

explainr

What is explainr?

explainr translates S3 objects into text using standard templates in a simple and convenient way.

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

Installation

The package can be installed with

devtools::install_github("hilaryparker/explainr")

After installation, the package can be loaded into R.

library(explainr)

Using explainr

The main function in the explainr package is explain().

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

Bug reports

Report bugs as issues on the GitHub repository

Contributors

Inspiration

This project draws inspiration from the CausalImpact package.