No description, website, or topics provided.
R
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R Added error message for template not found Mar 27, 2015
inst/themes added bioC vignette Mar 27, 2015
man Fixed output to be asis, fixed some bugs Mar 27, 2015
vignettes
.Rbuildignore Initial commit, fresh out of RStudio Mar 26, 2015
.gitignore first draft of explaining S3 objects Mar 26, 2015
DESCRIPTION added Roger Mar 27, 2015
LICENSE added Roger to license Mar 27, 2015
NAMESPACE Initial commit, fresh out of RStudio Mar 26, 2015
README.md Update README.md Apr 24, 2015
explainr.Rproj Fixed DESCRIPTION, fixed Rproj Mar 26, 2015

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.