helper_message: Helper function to display a message

View source: R/strr_helpers.R

helper_messageR Documentation

Helper function to display a message

Description

helper_message produces a formatted progress message.

Usage

helper_message(..., .type = "main", .quiet = NULL)

Arguments

...

Character strings to be displayed.

.type

One of c("open", "close", "main", "final"). "Open" prints a temporary message in grey italics with no timestamp. "Close" is designed to be called after "open", since it overwrites the previous line with a message in grey with a timestamp in cyan. "Main" is the same as "close" but does not override the previous line. "Final" is the same as "main" but appends an additional line in cyan bold which states the total time.

.quiet

The name of the argument in the calling function specifying whether messages should be displayed.

Value

A status message.


UPGo-McGill/strr documentation built on Feb. 24, 2024, 6:15 p.m.