README.md

In pubprint: Printing Results of Statistical Computing in a Publishable Way

pubprint

Pubprint is an extension for the R programming language. This package takes the output of several statistical tests, collects the characteristic values and transforms it in a publish-friendly pattern. Currently only the APA (American Psychological Association) style is supported with output to HTML, LaTeX, Markdown and plain text. The pubprint package is easily customizable, extendable and can be used well with knitr. Additionally pubprint offers a memory system that allows to save and retrieve results of computations.

The package is still in alpha stage. This means that it should work reliable but that the interface of the functions may be subject to change.

The Markdown output is in pandoc flavour and HTML output complies to MathML. If pubprint is used in a document that is processed by knitr, output format will be automatically determined.

Installation

CRAN, stable versions

Using CRAN installation is possible with a simple

install.packages("pubprint")

in a R session.

Bitbucket, stable versions

Download the package from here and install it in a Linux/Unix shell:

R CMD INSTALL pubprint_0.2.1.tar.gz

Bitbucket, development versions

Just download the current repository or get a copy with Mercurial from here and execute the makefile in the source directory:

hg clone https://bitbucket.org/mutluyum/pubprint
cd pubprint/
make

Please note that development versions may contain some bugs.

Documentation

You can find some documentation in the package documentation, later there will be an more in detail documentation with example files as well.

Requirements

R

• check DESCRIPTION file.

LaTeX

• The amsmath package may be required if text is set above or below another text (see out.above() and out.below()).
• The textgreek package for typesetting greek letters without switching to math mode.

Bugs and missing features

Of course, there aren't any bugs in the pubprint package. But you may encounter unexpected behaviour, missing features or cryptic error messages. If so, please report it to the issue tracker. Thank you!

Contribution

Any contribution to pubprint is appreciated! Have a look at the development page. Please notice that the package is published under the BSD 2-clause licence and you confirm it by contributing.

pubprint documentation built on May 29, 2017, 2:55 p.m.