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 = "open_issues.yaml"
)
#> Looking into open_issues.yaml ...
#> The issues will be read from /home/runner/work/_temp/Library/IssueTrackeR/data_issues/open_issues.yaml.

# Summarise one issue
summary(all_issues[1, ])
#> 
#> ── Issue jdemetra/jdplus-main#844 ──
#> 
#> Labels: bug
#> State: 🟢 Open
#> Nb comments: 0
#> 
#> Title: Charts are slow when displaying lots of observations
#> Text:
#> High frequencies provide a lot of observations. 
#> More than 600000 observations seems to be problematic in charts.
#> (see `sdmx-dl:/STATCAN_HFED/CCEI%2CDF_HFED_AB%2C1.0/H.CA_AB.CA_BC.NSI`).
#> 
#> 

# Summarise several issues
summary(all_issues[1:10, ])
#> There are 10 issues. 
#> - jdemetra/jdplus-main#844 🟢 Open 
#> - jdemetra/jdplus-main#843 🟢 Open 
#> - jdemetra/jdplus-main#842 🟢 Open 
#> - jdemetra/jdplus-main#841 🟢 Open 
#> - jdemetra/jdplus-main#840 🟢 Open 
#> - jdemetra/jdplus-main#838 🟢 Open 
#> - jdemetra/jdplus-main#837 🟢 Open 
#> - jdemetra/jdplus-main#821 🟢 Open 
#> - jdemetra/jdplus-main#820 🟢 Open 
#> - jdemetra/jdplus-main#819 🟢 Open