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

Description Usage Arguments

View source: R/issueReport.R

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

1
2
3
4
5
issuesGenPDF(style = "tint",
  RmdLocation = system.file("rmarkdown/templates/", "tint.Rmd", package =
  "issueReporter"), outputFile = NULL, outputDir = NULL,
  md = "markdownHere", setTitle = "Issue Notes",
  setAuthor = "Julius Caesar")

Arguments

style

Character string containing style. Tint is the only available for now until we add more styles/themes.

RmdLocation

Character string designating location of model Rmd.

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.

md

Character string containing markdown code to use in the report. Should be generated by issuesData2md().

setTitle

String containing report title.

setAuthor

String containing report author.


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