Compute a summary of an issue or a list of issues

# S3 method for class 'IssueTB'
summary(object, ...)

# S3 method for class 'IssuesTB'
summary(object, ...)

# S3 method for class 'LabelsTB'
summary(object, ...)

Arguments

object: a IssueTB or IssuesTB object.
...: Unused argument

Value

invisibly (with invisible()) NULL.

Details

This function compute the summary of an issue (IssueTB object) with adding some information (number of comments, ...). For a list of issues (IssuesTB object), it just summarise the information with statistics by modalities.

Examples

all_issues <- get_issues(
    source = "local",
    dataset_dir = system.file("data_issues", package = "IssueTrackeR"),
    dataset_name = "list_issues.yaml"
)
#> Looking into list_issues.yaml ...
#> The issues will be read from /home/runner/work/_temp/Library/IssueTrackeR/data_issues/list_issues.yaml.

# Summarise one issue
summary(all_issues[1, ])
#> For colourful links, add a labels argument (resulting from get_labels().
#> 
#> ── Issue jdemetra/jdplus-main#104 ──
#> 
#> Labels: 
#> Error in cat(x$labels, sep = ", "): argument 1 (type 'list') cannot be handled by 'cat'

# Summarise several issues
summary(all_issues[1:10, ])
#> There are 10 issues: 
#> - jdemetra/jdplus-main#104 🟢 Open 
#> - jdemetra/jdplus-main#236 🟢 Open 
#> - jdemetra/jdplus-main#238 ✔ Completed 
#> - jdemetra/jdplus-main#51 🟢 Open 
#> - jdemetra/jdplus-main#590 🟢 Open 
#> - jdemetra/jdplus-main#38 🟢 Open 
#> - jdemetra/jdplus-main#610 ✔ Completed 
#> - jdemetra/jdplus-main#658 ✔ Completed 
#> - jdemetra/jdplus-main#57 🟢 Open 
#> - jdemetra/jdplus-main#112 ♻ Re-opened