The package xplain is designed to help users interpret the results of their statistical analyses.
It does so not in an abstract way as textbooks do. Textbooks do not help the user of a statistical method understand his findings directly. What does a result of 3.14 actually mean? This is often hard to answer with a textbook alone because the book may provide its own examples but cannot refer to the specifics of the user’s case. However, as we all know, we understand things best when they are explained to us with reference to the actual problem we are working on. xplain is made to fill this gap that textbooks (and other learning materials) leave.
The basic idea behind xplain is simple: Package authors or other people intested in explaining statistics provide interpretation information for a statistical method (i.e. an R function) in the format of an XML file. With a simple syntax this interpretation information can reference the results of the user’s call of the explained R function. At runtime, xplain then provides the user with textual interpretation that really relates to his/her case.
Providing xplain interpretation information can be interesting for:
- R package authors who implement a statistical method
- statisticians who develop statistical methods themselves
- college and university teachers who want to make their teaching content more accessible for their students
- everybody who enjoys teaching and explaining statistics and thinks he/she has something to contribute
More ressources on xplain:
- xplain cheat sheet (PDF): http://www.zuckarelli.de/xplain/xplain_cheatsheet.pdf
- xplain on CRAN: https://cran.r-project.org/web/packages/xplain/index.html
- xplain on GitHub: https://www.github.com/jsugarelli/xplain
- xplain example XML files: http://www.zuckarelli.de/xplain/example_lm.xml and http://www.zuckarelli.de/xplain/example_lm_foreach.xml