create_ti_method_container {dynwrap}R Documentation

Create a TI method from a docker / singularity container

Description

These functions create a TI method from a container using babelwhale. Supports both docker and singularity as a backend. See vignette("create_ti_method_container", "dynwrap") for a tutorial on how to create a containerized TI method.

Usage

create_ti_method_container(
  container_id,
  pull_if_needed = TRUE,
  return_function = TRUE
)

Arguments

container_id

The name of the container repository (e.g. "dynverse/ti_angle").

pull_if_needed

Pull the container if not yet available.

return_function

Whether to return a function that allows you to override the default parameters, or just return the method meta data as is.

Value

A function that can be used to adapt the parameters of the method. This functions returns a list containing all metadata of the method, and can be used to infer a trajectory

See Also

vignette("create_ti_method_container", "dynwrap")

Examples

library(babelwhale)

# only run if docker works on this platform
if (test_docker_installation()) {
  method <- create_ti_method_container("dynverse/ti_angle")
  trajectory <- infer_trajectory(example_dataset, method())
}


[Package dynwrap version 1.2.2 Index]