projmgr (version 0.1.2)

get_issue_events: Get events for a specific issue from GitHub repository

Description

In addition to information returned by GitHub API, appends field "number" for the issue number to which the returned events correspond.

Usage

get_issue_events(ref, number, dummy_events = TRUE)

Value

Content of GET request as list

Arguments

ref

Repository reference (list) created by create_repo_ref()

number

Number of issue

dummy_events

Logical for whether or not to create a 'dummy' event to denote the existence of issues which have no events. Defaults to TRUE (to allow creation). Default behavior makes the process of mapping over multiple issues simpler.

See Also

Other issues: get_issue_comments(), get_issues(), parse_issue_comments(), parse_issue_events(), parse_issues(), post_issue_update(), post_issue(), report_discussion(), report_progress(), viz_waterfall()

Other events: parse_issue_events()

Examples

if (FALSE) {
myrepo <- create_repo_ref('emilyriederer', 'myrepo')

# single issue workflow
events_res <- get_issue_events(myrepo, number = 1)
events <- parse_issue_events(events_res)

# multi-issue workflow
issue_res <- get_issues(my_repo, state = 'open')
issues <- parse_issues(issues_res)
events <- purrr::map_df(issues$number, ~get_issue_events(myrepo, .x) %>% parse_issue_events())
}