issueReport: Generate a PDF report from a GitHub issue thread.

In issueReporter: Create Reports from GitHub Issues

Description

For a given GitHub issue, extracts all issue comments and generates a PDF report of each user's contributions to the thread. View /inst/examples/ to see a quick sample and output besides the usage below.

Usage

issueReport(issueNumber = 1, outputFile = NULL, outputDir = NULL,
  githubUsername = "xxxxxxxxxxxxxxxxxxxx",
  githubToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  githubUrl = "https://api.github.com/",
  githubRepo = "mkirch/issueReporter", setTitle = "Issue Notes",
  setAuthor = "Julius Caesar", includeTitle = TRUE, includeBody = TRUE,
  test = FALSE)

Arguments

issueNumber	Integer GitHub issue number.
outputFile	String containing file name for R Markdown pdf output, report.Rmd if NULL.
outputDir	String containing directory address for R markdown output, working directory if NULL.
githubUsername	String of GitHub username to authenticate with.
githubToken	String containing GitHub personal access token, as generated from the settings area in your GitHub account.
githubUrl	String containing the API URL for GitHub. If using a GitHub Enterprise account, use http(s)://hostname/api/v3/ instead of default. Please make sure to append a `/`.
githubRepo	String of format user/repo specifying the GH repo.
setTitle	String containing report title.
setAuthor	String containing report author.
includeTitle	Bool where TRUE includes the title, and FALSE excludes.
includeBody	Bool where TRUE includes the original issue, and FALSE includes only the issue comments.
test	Bool If we are using this in test mode.

issueReporter documentation built on May 30, 2017, 6:24 a.m.