param_others: Define Other Object Parameters

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

Define Other Object Parameters

Description

Define Other Object Parameters

Usage

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

Arguments

id	A parameter name. Default is NULL.
type	The type of parameter, which can be a list or any other object you input.
default	The default input.
description	The description information of this parameter.
force	Logical, whether this parameter must be needed or not.
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

list_input <- param_others(
id = 'input_list',
type = "list",
process = "simulation"
)

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