report_progress: Print issue-milestone progress in RMarkdown friendly way

In projmgr: Task Tracking and Project Management with GitHub

Print issue-milestone progress in RMarkdown friendly way

Description

Interprets dataframe or tibble of items (e.g. issues) by breaking apart groups (e.g. milestones), listing each item title as open or closed, and using HTML to format results in a highly readable and attractive way. Resulting object returned is a character vector of HTML code with the added class of 'knit_asis' so that when included in an RMarkdown document knitting to HTML, the results will be correctly rendered as HTML.

Usage

report_progress(
  issues,
  group_var = "milestone_title",
  link_url = TRUE,
  show_ratio = TRUE,
  show_pct = TRUE
)

Arguments

issues	Dataframe or tibble of issues and milestones, as returned by get_issues() and parse_issues()
group_var	Character string variable name by which to group issues. Defaults to "milestone_title"
link_url	Boolean. Whether or not to provide link to each item, as provided by url column in dataset
show_ratio	Boolean. Whether or not to report (# Closed Items / # Total Items) for each group as a ratio
show_pct	Boolean. Whether or not to report (# Closed Items / # Total Items) for each group as a percent

Details

The resulting HTML unordered list (⁠<ul>⁠) is tagged with class 'report_progress' for custom CSS styling.

Items without a related group are put into an "Ungrouped" category. Filter these out before using this function if you wish to only show items that are in a group.

Value

Returns character string of HTML with class attribute to be correctly shown "as-is" in RMarkdown

See Also

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

Examples

## Not run: 
repo <- create_repo_ref("emilyriederer", "projmgr")
issues <- get_issues(repo, state = 'all')
issues_df <- parse_issues(issues)
report_progress(issues_df)

## End(Not run)

projmgr documentation built on May 29, 2024, 5 a.m.