data <- function(state) {
    # Do something
}

config_options <- function(state) {
    # Do something
}

Each function takes a single parameter, called state in this example, but it can be called anything you like that is not a reserved keyword. The state object in this example is the gateway in and out of our component. All of the data handed to the input port is accessible through this object. Additionally, we will bind our output to this object. Lastly, there are a number of utility functions already loaded into the namespace of our component that will help work with this gateway.

config_options <- function(state) {
    input_port_data <- v_export(state$api$inputstate)
    my_data <- input_port_data$config_options
}

The v_export utility function converts all of the input data from all of the ports into a list with a property for each port's data. We can further bind the specific data we received from a port by accessing it's property (which is named the same thing as the port name).

Getting Results Back Out

config_options <- function(state) {
    input_port_data <- v_export(state$api$inputstate)
    my_data <- input_port_data$config_options

    result <- from_my_model(
        period = config_options$period,
        sensitivity = config_options$sens
    )

    state$api$output(name = "data", value = v_import(result))
}

Outputs are bound back to the state options to be sent to the outputs ports of your application. The utility function v_import() will automatically convert your data from R to Exaptive data types (see table below). Since Exaptive datatypes are analogous to JSON, the data you export will need to be JSON serializable types.

NOTE: Only data bound to the state object will be sent to any output ports, there is no need to return data from your main function.

helper_function <- function(period, sensitivity) {
    # Do something
    return(period + sensitivity)
}

config_options <- function(state) {
    input_port_data <- v_export(state$api$inputstate)
    my_data <- input_port_data$config_options

    result <- helper_function(
        period = config_options$period,
        sensitivity = config_options$sens
    )

    state$api$output(name = "data", value = v_import(result))
}

...
"dependencies": {
"file": [],
"cran": [
{"path": "dplyr"},
{"path": "stringr"}
]
},
...

Then, inside your code, load the library namespace as normal.

library(dplyr)
library(stringr)