summarize_github_labels: Summary of GitHub labels from CSV file

In fmichonneau/carpenter: Tools to work with The Carpentries GitHub repositories

Summary of GitHub labels from CSV file

Description

Creates an HTML formatted table or list to be included in the Carpentry handbook or other resources

Usage

summarize_github_labels(label_csv, format = "html", escape = FALSE, ...)

document_github_labels(label_csv, out = NULL)

Arguments

label_csv	the path to a CSV file that describes the labels. It should have the following columns: print_order, type, label, color, use_prefix, description, long_description. The canonical version of this file lives in The Carpentries repository's (https://github.com/carpentries/handbook/) data/ folder.
format	format of the output table (passed to kable).
escape	should the HTML be escaped (passed to kable).
...	additional arguments to be passed to kable.
out	path to file to write the HTML file documenting the labels

Details

summarize_github_labels creates a table, while document_github_labels creates a list.

See create_github_labels() for a description of the CSV file format expected by this function.

Value

An HTML formatted table that shows the type of label, its color and its description.

fmichonneau/carpenter documentation built on July 5, 2022, 7:08 a.m.