report_taskboard: Report HTML-based task board of item status

In projmgr: Task Tracking and Project Management with GitHub

Report HTML-based task board of item status

Description

Produces three column task board showing any relevant objects (typically issues or milestones) as "Not Started", "In Progress", or "Done".

Usage

report_taskboard(
  data,
  in_progress_when,
  include_link = FALSE,
  hover = FALSE,
  colors = c("#f0e442", "#56b4e9", "#009e73")
)

Arguments

data	Dataset, such as those representing issues or milestones (i.e. from parse_issues()). Must have state variable.
in_progress_when	Function with parameter data that returns Boolean vector. Generally, one of the taskboard helper functions. See ?taskboard_helpers for details.
include_link	Boolean whether or not to include links back to GitHub
hover	Boolean whether or not tasks should be animated to slightly enlarge on hover
colors	Character vector of hex colors for not started, in progress, and complete tasks (respectively)

Details

The following logic is used to determine the status of each issue:

• Done: Items with a state of "closed"

• In Progress: Custom logic via in_progress_when. See ?taskboard_helpers for details.

• Not Started: Default case for items neither In Progress or Closed

Value

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

Examples

## Not run: 
# in RMarkdown
```{r}
issues <- get_issues(myrepo, milestone = 1)
issues_df <- parse_issues(issues)
report_taskboard(issues_df, in_progress_when = is_labeled_with('in-progress'))
````

## End(Not run)

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