param_Boolean: Define Logical Parameters

In duohongrui/simutils: Common functions used in data simulation and evaluation

Define Logical Parameters

Description

Define a Boolean parameter.

Usage

param_Boolean(
  id,
  type = "logical",
  default,
  force = FALSE,
  description = NULL,
  process = "simulation",
  function_name
)

Arguments

id	A parameter name.
type	The type of parameter. Must be a logical value.
default	The default value. TRUE or FALSE.
force	Logical, whether this parameter must be needed or not.
description	The description information of this parameter.
process	Two options, simulation or estimation. Which process does this parameter involved in.
function_name	The function name where the parameter exists.

Value

A list.

Examples

verbose <- param_Boolean(
id = "verbose",
default = TRUE,
force = TRUE,
description = "Whether to return the information during the process"
)

duohongrui/simutils documentation built on March 12, 2024, 8:40 p.m.