explainr v0.1

by Hilary Parker

Explains R in plain English

Explains R objects in plain English, based on a set of templates.

Readme

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.

Functions in explainr

Name Description
load_theme Load a theme, which is a directory of templates
load_themes Load all themes
explainr_themes Built-in themes
explain.default explain an S3 object in plain English
explain Explain an object in plain English
explainr_mode register a session so that it explains each line
load_template Load a .Rmd template for displaying an object
compile_template compile an object using a template
explain_line explain a line of dplyr code
explainr_output Wrap an object as the output of an
print.explainr_output Print explainr output
No Results!

Details

Type Package
Date 2015-03-26
License MIT + file LICENSE
LazyData TRUE
URL http://github.com/hilaryparker/explainr
VignetteBuilder knitr
BugReports http://github.com/hilaryparker/explainr/issues

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/explainr)](http://www.rdocumentation.org/packages/explainr)