param_reference: Define Reference Dataset Parameters

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

Define Reference Dataset Parameters

Description

Define Reference Dataset Parameters

Usage

param_reference(
  id = NULL,
  type = NULL,
  default = NULL,
  alternatives = c("matrix", "SingleCellExperiment", "dataframe"),
  force = FALSE,
  description = NULL,
  process = "simulation",
  function_name
)

Arguments

id	A parameter name. Default is NULL, which means no reference matrix input.
type	The type of parameter. Default is NULL. See alternatives.
default	In simulation, it means the reference dataset where methods learn the parameters from. Default is NULL.
alternatives	Alternative options.
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

matrix_input_method <- param_reference(
id = 'matrix_input',
type = "SingleCellExperiment",
process = "estimation",
description = "The matrix to use for parameters estimating."
)

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