vp: Print and Log Messages

View source: R/ubiquity.r

vpR Documentation

Print and Log Messages

Description

Used to print messages to the screen and the log file.

Usage

vp(cfg, str, fmt = "alert")

Arguments

cfg

ubiquity system object

str

sequence of strings to print

fmt

string format should be one of the following: "h1", "h2", "h3", "verbatim", "alert" (default), "warning", "danger".

Value

Boolean variable indicating success (TRUE) or failure (FALSE)

Examples


# Creating a system file from the mab_pk example
fr = system_new(file_name        = "system.txt", 
                system_file      = "mab_pk", 
                overwrite        = TRUE, 
                output_directory = tempdir())

# Building the system 
cfg = build_system(system_file  = file.path(tempdir(), "system.txt"),
      output_directory          = file.path(tempdir(), "output"),
      temporary_directory       = tempdir())

# Initialzing the log file
vp(cfg, "Message that will be logged")


ubiquity documentation built on Nov. 2, 2023, 6:26 p.m.