taskboard_helpers: Tag "in-progress" items for taskboard visualization

In projmgr: Task Tracking and Project Management with GitHub

Tag "in-progress" items for taskboard visualization

Description

The viz_taskboard() function creates a three-column layout of entities that are not started, in progress, or done. Objects are classified as done when they have a state of "closed". Object are classified as "To-Do" when they are neither "Closed" or "In Progress". However, what constistutes "In Progress" is user and project dependent. Thus, these functions let users specify what they mean.

Usage

is_labeled()

is_labeled_with(label, any = TRUE)

is_assigned()

is_assigned_to(login, any = TRUE)

is_in_a_milestone()

is_in_milestone(number)

is_created_before(created_date)

is_part_closed()

is_due()

is_due_before(due_date)

has_n_commits(events, n = 1)

Arguments

label	Label name(s) as character vector
any	When the supplied vector has more than one value, should the result return TRUE if any of those values are present in the dataset (logical OR)
login	User login(s) as character vector
number	Milestone number
created_date	Date as character in "YYYY-MM-DD" format
due_date	Date as character in "YYYY-MM-DD" format
events	Dataframe containing events for each issue in data
n	Minimum of commits required to be considered in progress

Details

General options:

• is_created_before: Was created before a user-specified data (as "YYYY-MM-DD" character string)

Issue-specific options:

• is_labeled_with: User-specified label (as character string) exists

• is_assigned: Has been assigned to anyone

• is_assigned_to: Has been assigned to specific user-specified login (as character string)

• is_in_a_milestone: Has been put into any milestone

• is_in_milestone: Has been put into a specific milestone

Milestone-specific options:

• is_part_closed: Has any of its issues closed

• is_due: Has a due date

• is_due_before: Has a due data by or before a user-specified date (as "YYYY-MM-DD" character string)

Value

Function to be passed as in_progress_when argument in viz_taskboard()

Examples

## Not run: 
viz_taskboard(issues, in_progress_when = is_labeled_with('in-progress'))
viz_taskboard(milestones, in_progress_when = is_created_before('2018-12-31'))
viz_taskboard(issues, in_progress_when = is_in_milestone())
report_taskboard(issues, in_progress_when = is_labeled_with('in-progress'))
report_taskboard(milestones, in_progress_when = is_created_before('2018-12-31'))
report_taskboard(issues, in_progress_when = is_in_milestone())

## End(Not run)

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