param_vector: Define Vector Parameters

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

Define Vector Parameters

Description

Define Vector Parameters

Usage

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

Arguments

id	A parameter name.
type	The type of parameter.
default	The default values. Length to one or more.
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

path_method <- param_vector(
id = 'path',
default = c(0,1,2,3),
process = "simulation"
)

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