system_view: View Information About the System

View source: R/ubiquity.r

system_viewR Documentation

View Information About the System

Description

Displays information (dosing, simulation options, covariates, etc) about the system.

Usage

system_view(cfg, field = "all", verbose = FALSE)

Arguments

cfg

ubiquity system object

field

string indicating the aspect of the system to display

verbose

Boolean variable that when set to true will echo the information to the screen

Value

sequence of strings with system in formation (one line per element)

The field

  • "all" will show all information about the system

  • "parameters" summary of parameter information

  • "bolus" currently set bolus dosing

  • "rate" infusion rate dosing

  • "covariate" covariates

  • "iiv" variance/covariance information

  • "datasets" loaded datasets

  • "simulation" simulation options

  • "estimation" estimation options

  • "nca" non-compartmental analyses that have been performed

Examples

# To log and display the current system information:

# 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())

  msgs = system_view(cfg, verbose=TRUE)


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