Skip to contents

Set or Get Monte Carlo Inputs Table

Source: R/set_mctable.R
set_mctable.Rd

Manages a Monte Carlo inputs table in the global package environment by either setting new data or retrieving the current table. The table stores information about Monte Carlo nodes including their descriptions, functions, dependencies, and sensitivity analysis settings.

Usage

set_mctable(data = NULL)

Arguments

data

Optional data frame containing MC table information. Must contain an 'mcnode' column. Other columns will be auto-filled if missing. If NULL, returns the current MC table.

Value

  • If data = NULL: Returns the current MC table

  • If data provided: Sets the new MC table and returns invisibly

The table contains the following columns:

  • mcnode - Character. Name of the Monte Carlo node (required)

  • description - Character. Description of the node

  • mc_func - Character. Monte Carlo function to be used

  • from_variable - Character. Dependency on other variables

  • transformation - Character. Transformation to be applied

  • sensi_analysis - Logical. Whether to include in sensitivity analysis

Examples

# Get current MC table
current_table <- set_mctable()

# Set new MC table
mct <- data.frame(
  mcnode = c("h_prev", "w_prev"),
  description = c("Herd prevalence", "Within herd prevalence"),
  mc_func = c("runif", "runif"),
  sensi_analysis = c(TRUE, TRUE)
)
set_mctable(mct)
#> Warning: The following columns were not specified and will be filled with default values: from_variable, transformation
#> mctable set to structure(list(mcnode = c("h_prev", "w_prev"), description = c("Herd prevalence", "Within herd prevalence"), mc_func = c("runif", "runif"), sensi_analysis = c(TRUE, TRUE), from_variable = c(NA, NA), transformation = c(NA, NA)), row.names = c(NA, -2L), class = "data.frame")