catsplainr v0.1

by Hilary Parker

Makes a cat explain R in plain English

Makes a cat explain R objects in plain English, based on a set of templates.

Readme

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

Functions in catsplainr

Name Description
hello Hello, World!
No Results!

Details

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

Include our badge in your README

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