Create a definition

Source: R/method_process_definition.R

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.

definition(method, wrapper, manuscript = NULL, container = 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()).
parameters

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

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))
  )
)
#> $method
#> $method$id
#> [1] "some_method"
#> 
#> $method$name
#> [1] "some_method"
#> 
#> $method$source
#> [1] "tool"
#> 
#> $method$tool_id
#> NULL
#> 
#> $method$platform
#> NULL
#> 
#> $method$url
#> NULL
#> 
#> $method$license
#> NULL
#> 
#> $method$authors
#> list()
#> 
#> $method$description
#> NULL
#> 
#> 
#> $wrapper
#> $wrapper$input_required
#> [1] "expression"
#> 
#> $wrapper$input_optional
#> character(0)
#> 
#> $wrapper$type
#> [1] "trajectory"
#> 
#> $wrapper$topology_inference
#> NULL
#> 
#> $wrapper$trajectory_types
#> character(0)
#> 
#> $wrapper$inputs
#> # A tibble: 2 x 3
#>   input_id   required type      
#>   <chr>      <lgl>    <chr>     
#> 1 expression TRUE     expression
#> 2 k          FALSE    parameter 
#> 
#> 
#> $manuscript
#> NULL
#> 
#> $container
#> NULL
#> 
#> $parameters
#> k | type=integer | domain=U(3, 20) | default=5
#> attr(,"class")
#> [1] "dynwrap::ti_method" "list"