parameter_sets: Generate Parameter sets

View source: R/parameters.R

parameter_setsR Documentation

Generate Parameter sets

Description

Collect and return all defined parameters.

Usage

parameter_sets(...)

Arguments

...

Defined lists of parameters.

Value

A list contains the parameters of estimating process and simulation process

See Also

param_numeric(), param_character(), param_Boolean(), param_integer()

Examples

param_set <- parameter_sets(
param_character(id = 'dimension_method',
                default = "UMAP",
                alternatives = c("UMAP", "TSNE", "PCA"),
                force = TRUE,
                description = "The algorithm to use for dimensionality reduction.",
                function_name = "a"),
param_Boolean(id = "verbose",
              default = TRUE,
              process = 'estimation',
              description = "Whether to return the information during the process",
              function_name = "a"),
param_integer(id = "group_num",
              default = 1L,
              lower = 1L,
              upper = 50L,
              border = TRUE,
              description = "How many groups to be simulated",
              function_name = "b"),
param_numeric(id = "probability",
              default = 0.5,
              lower = 0,
              upper = 1,
              border = TRUE,
              force = TRUE,
              process = 'estimation',
              description = "The probability to select the right number",
              function_name = "b")
)

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