messages: messages

In namc-utah/NAMCr: NAMC Database Access API

messages

Description

R6 class for handling package messages

Value

a messages class (R6 class)

Public fields

iLevel

is the index of the level contained in levels. Initialize object

Methods

Public methods

• messages$new()

• messages$display()

• messages$clone()

---

Method new()

Usage

messages$new(level = "INFO")

Arguments

level

The text message type to initialize messaging to

Returns

none Nothing is returned

Title

---

Method display()

Usage

messages$display(msg, type = "INFO")

Arguments

msg

string A message to display

type

string The type of the message

Returns

Examples

msg = messages::new(level = 'DEBUG')
msg$display("this is a message")

---

Method clone()

The objects of this class are cloneable with this method.

Usage

messages$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

msg = messages$new(level = "INFO")


## ------------------------------------------------
## Method `messages$display`
## ------------------------------------------------


msg = messages::new(level = 'DEBUG')
msg$display("this is a message")

namc-utah/NAMCr documentation built on Feb. 12, 2024, 4:29 a.m.