printify

Description

A lightweight message system relying purely on base R. Comes with built-in and pre styled message types and provides an easy way to create custom messages. Supports individually styled and colored text as well as timing information. Designed to make console output more informative and visually organized.

Minimal R Version

4.1.0 or higher

Functions

#' Messages: print_message(), print_headline(), print_start_message(), print_closing(), print_step(), set_up_custom_message(), get_message_stack(), set_no_print(), print_stack_as_messages(), convert_square_brackets()

Author(s)

Tim Siebenmorgen

See Also

Useful links:

• https://github.com/s3rdia/printify

• https://deepwiki.com/s3rdia/printify

• https://s3rdia.github.io/qol_blog/

Convert Color Codes

Description

hex_to_256(): Generate a 256-color 6x6x6 color cube.

hex_to_ansi(): Applies hex color and font weight to a text as ansi codes.

Usage

hex_to_256(hex_color)

hex_to_ansi(text, hex_color = NULL, bold = FALSE)

Arguments

Value

hex_to_256(): Returns 6x6x6 color cube.

hex_to_ansi(): Returns formatted text.

Examples

color_cube <- hex_to_ansi("#32CD32")

formatted_text <- hex_to_ansi("This is a text to test the coloring",
                              hex_color = "#32CD32", bold = TRUE)

Message Helper Functions

Description

get_message_stack(): Retrieves the current message stack as list or data frame.

set_no_print(): FALSE by default. If set to TRUE the messages will be formatted and returned but not printed to the console. Can e.g. be used in unit test situations.

print_stack_as_messages(): Prints the message stack as actual messages (only not suppressed messages). Can be used to trigger expect_message, expect_warning or expect_error in unit tests.

convert_square_brackets(): Convert different curly bracket patterns into ansi formatting or passes the context of vectors into the text.

Usage

get_message_stack(as_data_frame = FALSE)

set_no_print(value = FALSE)

print_stack_as_messages(type = NULL)

convert_square_brackets(text, ...)

Arguments

Details

The message types in which you can enter custom texts, are capable of using different styling operators. These are:

• Insert list of elements: [vector_name]

• Adding conditional words, if list of elements has more than one element: [?word]

• Adding conditional singular/plural, depending on list of element length: [?singular/plural]

• Bold, italic and underline: [b]some text[/b], [i]some text[/i], [u]some text[/u]

• Coloring parts of the message: [#FF00FF some text]

Value

get_message_stack(): Returns a list of messages or a data frame.

set_no_print(): Returns the global no_print option.

print_stack_as_messages(): Returns NULL.

convert_square_brackets(): Returns formatted text.

See Also

Main printing functions: print_message(), print_headline(), print_start_message(), print_closing(), print_step(), set_up_custom_message()

Print Styled Messages

Description

Printing styled messages for different occasions. There are notifications, warnings, errors, function call headlines, progress and function closing messages. Or just a neutral one.

Usage

print_message(
  type,
  text,
  ...,
  always_print = FALSE,
  utf8 = .printify_messages[["format"]][["utf8"]]
)

print_headline(
  text,
  ...,
  line_char = "=",
  max_width = getOption("width"),
  always_print = FALSE
)

print_start_message(
  current_time = Sys.time(),
  caller_color = "#63C2C9",
  always_print = FALSE,
  suppress = FALSE
)

print_closing(
  time_threshold = 2,
  start_time = .printify_messages[["start_time"]],
  caller_color = "#63C2C9",
  always_print = FALSE,
  suppress = FALSE
)

print_step(
  type,
  text,
  ...,
  always_print = FALSE,
  utf8 = .printify_messages[["format"]][["utf8"]]
)

set_up_custom_message(
  ansi_icon = NULL,
  text_icon = "^",
  indent = 1,
  type = "UNICORN",
  color = "#FF00FF",
  text_bold = FALSE,
  text_italic = FALSE,
  text_underline = FALSE,
  text_color = NULL
)

Arguments

Details

The message types in which you can enter custom texts, are capable of using different styling operators. These are:

• Insert list of elements: [vector_name]

• Adding conditional words, if list of elements has more than one element: [?word]

• Adding conditional singular/plural, depending on list of element length: [?singular/plural]

• Bold, italic and underline: [b]some text[/b], [i]some text[/i], [u]some text[/u]

• Coloring parts of the message: [#FF00FF some text]

Value

Return text without styling or total running time.

set_up_custom_message(): Returns a list.

See Also

Also have a look at the small helpers: get_message_stack(), set_no_print(), print_stack_as_messages(), convert_square_brackets()

Examples

# Example messages
print_message("NOTE", c("Just a quick note that you can also insert e.g.[? a / ]variable",
                        "name[?s] like this: [listing].",
                        "Depending on the number of variables you can also alter the text."),
             listing = c("age", "state", "NUTS3"))

print_message("WARNING", "Just a quick [#FF00FF colored warning]!")

print_message("ERROR", "Or a [b]bold[/b], [i]italic[/i] and [u]underlined[/u] error.")

print_message("NEUTRAL", c("You can also just output [u]plain text[/u] if you like and use",
                           "[#FFFF00 [b]all the different[/b] [i]formatting options.[/i]]"))

# Different headlines
print_headline("This is a headline")

print_headline("[#00FFFF This is a different headline] with some color",
               line_char = "-")

print_headline("[b]This is a very small[/b] and bold headline",
               line_char = ".",
               max_width = 60)

# Messages with time stamps
test_func <- function(){
    print_start_message()
    print_step("GREY", "Probably not so important")
    print_step("MAJOR", "This is a major step...")
    print_step("MINOR", "Sub step1")
    print_step("MINOR", "Sub step2")
    print_step("MINOR", "Sub step3")
    print_step("MAJOR", "[b]Finishing... [/b][#00FFFF with some color again!]")
    print_closing()
}

test_func()

# See what is going on in the message stack
message_stack <- get_message_stack()

# Set up a custom message
hotdog <- set_up_custom_message(ansi_icon = "\U0001f32d",
                                text_icon = "IOI",
                                indent    = 1,
                                type      = "HOTDOG",
                                color     = "#B27A01")

hotdog_print <- function(){
    print_start_message()
    print_message(hotdog, c("This is the first hotdog message! Hurray!",
                            "And it is also multiline in this version."))
    print_step(hotdog, "Or use as single line message with time stamps.")
    print_step(hotdog, "Or use as single line message with time stamps.")
    print_step(hotdog, "Or use as single line message with time stamps.")
    print_closing()
}

hotdog_print()

# See new message in the message stack
hotdog_stack <- get_message_stack()