param_dataframe: Define Dataframe Object Parameters
In duohongrui/simutils: Common functions used in data simulation and evaluation

param_dataframe

R Documentation

Define Dataframe Object Parameters

Description

Define Dataframe Object Parameters

Usage

param_dataframe(
  id = NULL,
  type = c("data.frame", "tibble"),
  description = NULL,
  force = FALSE,
  process = "simulation",
  function_name
)

Arguments

`id`	A parameter name. Default is NULL, which means no dataframe object input.
`type`	The type of parameter. Must be a data.frame or tibble.
`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

network_input <- param_dataframe(
id = 'network',
process = "simulation",
description = "The network information is used to show the relationship of nodes."
)

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