definition {dynwrap}

Create a definition

Description

A definition contains meta information on a TI method and various aspects thereof. For brevity, the example only contains a minimum example, check the documentation of the ⁠def_*⁠ helper functions for more extensive examples.

Usage

definition(
  method,
  wrapper,
  manuscript = NULL,
  container = NULL,
  package = NULL,
  parameters = parameter_set()
)

is_ti_method(method)

Arguments

method

Meta information on the TI method (see def_method()).

wrapper

Meta information on the wrapper itself (see def_wrapper()).

manuscript

Meta information on the manuscript, if applicable (see def_manuscript()).

container

Meta information on the container in which the wrapper resides, if applicable (see def_container()).

package

Meta information on the package in which the wrapper resides, if applicable (see def_package()).

parameters

Meta information on the parameters of the TI method (see def_parameters()).

Value

A method definition

Examples

library(dynparam)
definition(
  method = def_method(id = "some_method"),
  wrapper = def_wrapper(input_required = "expression"),
  parameters = parameter_set(
    integer_parameter(id = "k", default = 5L, distribution = uniform_distribution(3L, 20L))
  )
)