README.md

In mkirch/issueReporter: Create Reports from GitHub Issues

issueReporter

Create reports from GitHub Issues threads in R.

Background and Motivation

Sometimes you've got Issues. There is occasionally a need to create a quality document from these threads. I needed a professional-looking PDF to take notes on, originating from the content of a GitHub Issues thread, and I needed it to be produced on a regular basis. This satisfies that use case, and allows for the generation of general documents from Issues on both GitHub and GitHub Enterprise with a simple wrapper.

Getting Started

issueReporter is now on CRAN! To install the R package, simply:

R> install.packages("issueReporter")

In order to use the main function issueReport(), you must first create a Personal Access Token in your GitHub or GitHub Enterprise account settings. Instructions to do so can be found here.

Documents are well styled thanks to Dirk Eddelbuettel's tint package. Note that all of the requirements for tint must be fulfilled. Future themes/styles will come in the future, as well as support for HTML output.

Example: Issue Thread

Example: Report Generated from Issue Thread

mkirch/issueReporter documentation built on May 7, 2019, 12:42 p.m.