Print and Log Messages

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

# \donttest{
# 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())
#> 
#> ── Building the system: /var/folders/pq/7srbf_fx3rd3k706hgxkg61r0000gp/T//Rtmprz
#> → ubiquity:     https://r.ubiquity.tools
#> → Distribution: package (2.0.4)
#> → Compiling C version of system
#> → Loading the shared C library
#> ✔ System built
#> ℹ To fetch a new analysis template use `system_fetch_template`
#> ℹ For example:
#> ℹ   fr = system_fetch_template(cfg, template = "Simulation")
#> ℹ   fr = system_fetch_template(cfg, template = "Estimation")

# Initialzing the log file
vp(cfg, "Message that will be logged")
#> → Message that will be logged
#> [1] TRUE
# }