Description Usage Arguments Details Value See Also Examples
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
'knit_asis' so that when included in an RMarkdown document knitting to HTML,
the results will be correctly rendered as HTML.
report_progress(issues, group_var = "milestone_title", link_url = TRUE, show_ratio = TRUE, show_pct = TRUE)
Dataframe or tibble of issues and milestones, as returned by
Character string variable name by which to group issues. Defaults to
Boolean. Whether or not to provide link to each item, as provided by
Boolean. Whether or not to report (# Closed Items / # Total Items) for each group as a ratio
Boolean. Whether or not to report (# Closed Items / # Total Items) for each group as a percent
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.
Returns character string of HTML with class attribute to be correctly shown "as-is" in RMarkdown
1 2 3 4 5 6 7
## 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)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.