parse_issue_events: Parse issue events from 'get_issues_events'

In emilyriederer/projmgr: Task Tracking and Project Management with GitHub

Parse issue events from get_issues_events

Description

This function convert list output returned by get into a dataframe. Due to the diverse fields for different types of events, many fields in the dataframe may be NA.

Usage

parse_issue_events(res)

Arguments

res	List returned by corresponding get_ function

Details

Currently, the following event types are unsupported (with regard to processing all of their fields) due to their additional bulk and limited utility with respect to this packages functionality. Please file an issue if you disagree:

• (removed_from/moved_columns_in/added_to)_project: Since this package has limited value with GitHub projects

• converted_note_to_issue: Since issue lineage is not a key concern

• head_ref_(deleted/restored): Since future support for pull requests would likely be handled separately

• merged: Same justification as head_ref

• review_(requested/dismissed/request_removed): Same justification as head_ref

Value

Dataframe with one record / issue-event

See Also

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

Other events: get_issue_events()

Examples

## Not run: 
myrepo <- create_repo_ref('emilyriederer', 'myrepo')
events_res <- get_issue_events(myrepo, number = 1)
events <- parse_issue_events(events_res)

## End(Not run)

emilyriederer/projmgr documentation built on Jan. 26, 2024, 3:09 a.m.