print_message: Print a message

Description Usage Arguments Examples

View source: R/print_message.R

Description

Print pretty messages to standard out to update the user.

Usage

1
2
3
4
5
6
7
print_message(
  message,
  print_title = TRUE,
  mask_character = " ",
  section = "CTutils",
  level = 0
)

Arguments

message

The message that is to be printed.

print_title

Print a title to the message (defined in section)

mask_character

Use this character in place of the title (if print_title is FALSE). Default is a space.

section

The section name to be printed in message preamble.

level

The level of indentation required for this message.

Examples

1
print_message( "example" )

LisaHopcroft/CTutils documentation built on Oct. 7, 2021, 11:08 p.m.