get_issues: Retrieve all issues on a repository

In githubr: Easier to Use API Wrapper for 'GitHub'

Retrieve all issues on a repository

Description

Given a repository name, get a list of issues.

Usage

get_issues(repo_name, how_many = "all", git_pat = NULL, verbose = TRUE)

Arguments

repo_name	the name of the repository to retrieve issues from, e.g. jhudsl/OTTR_Template
how_many	put the number of how many you would like returned. If all, put "all". By default will return all issues.
git_pat	A personal access token from GitHub. Only necessary if the repository being checked is a private repository.
verbose	TRUE/FALSE do you want more progress messages?

Value

A data frame that contains information about the issues from the given repository

Examples

 ## Not run: 

# First, set up your GitHub credentials using `usethis::gitcreds_set()`.
# Get a GitHub personal access token (PAT)
usethis::create_github_token()

# Give this token to `gitcreds_set()`
gitcreds::gitcreds_set()

# Now you can retrieve issues
issues_df <- get_issues("jhudsl/OTTR_Template")
# Alternatively, you can supply the GitHub PAT directly
# to the function to avoid doing the steps above.
issues_df <- get_issues("jhudsl/OTTR_Template", git_pat = "gh_somepersonalaccesstokenhere")

## End(Not run)

githubr documentation built on Oct. 20, 2023, 5:09 p.m.