scicomptools (version 1.1.1)

issue_extract: Export GitHub issues as PDF Files

Description

Exports specified GitHub issues as PDF files when given the URL of a GitHub repository and a numeric vector of GitHub issue numbers. This function will export the first 10 issues as a default.

Usage

issue_extract(
  repo_url = NULL,
  issue_nums = 1:10,
  export_folder = NULL,
  cookies = NULL,
  quiet = FALSE
)

Value

No return value, called for side effects

Arguments

repo_url

(character) URL of the GitHub repository as a character string.

issue_nums

(numeric) Numeric vector of the issue numbers to be exported. Default is issue #1 through #10.

export_folder

(character) Name of the folder that will be created to contain the output PDF files. Default is "exported_issues".

cookies

(character) Optional file path to the cookies to load into the Chrome session. This is only required when accessing GitHub repositories that require a login. See this link for more details: https://github.com/rstudio/chromote/blob/main/README.md#websites-that-require-authentication.

quiet

(logical) Whether to silence informative messages while issues are being exported. Default is FALSE.

Examples

if (FALSE) {
# Export GitHub issue #7000 and #7080 through #7089 for the public `dplyr` repository 
issue_extract(repo_url = "https://github.com/tidyverse/dplyr",
              issue_nums = c(7000, 7080:7089),
              export_folder = "dplyr_issues")
}