FM_message {formods}R Documentation

Show Message to User

Description

Writes a message to the console depending on whether cli is installed or not.

Usage

FM_message(line, escape_braces = TRUE, entry_type = "alert")

Arguments

line

Text to display

escape_braces

Set to TRUE (default) to escape curly braces in the entry, set to FALSE to have the values interpreted.

entry_type

Set to either "alert"(default), "danger", "info", "success", "warning", "h1", "h2", or "h3"

Value

Returns NULL

Examples

mr = FM_message("This is a normal  message")
mr = FM_message("This is a danger  message", entry_type="danger")
mr = FM_message("This is a info    message", entry_type="info")
mr = FM_message("This is a success message", entry_type="success")
mr = FM_message("This is a warning message", entry_type="warning")
mr = FM_message("This is an H1 header",      entry_type="h1")
mr = FM_message("This is an H2 header",      entry_type="h2")
mr = FM_message("This is an H3 header",      entry_type="h3")

[Package formods version 0.1.4 Index]