model_run {peermodels}R Documentation

Executes PRISM model

Description

Executes PRISM model

Usage

model_run(
  model_name = NULL,
  model_input = NULL,
  api_key = NULL,
  server = NULL,
  async = FALSE,
  email_address = NULL
)

Arguments

model_name

name of the model

model_input

required custom parameters for current model

api_key

API key

server

server address. Defaults to the Peer Models Network PRSIM repository.

async

should the model be called in async mode?

email_address

async results will be emailed to this address

Value

0 for success and 1 for error

Examples

## Not run: 
sample_input <- get_default_input(model_name = "epic", api_key = "YOUR_API_KEY")
sample_input$global_parameters.time_horizon <- 15
model_run ("epic", model_input = sample_input)

## End(Not run)

[Package peermodels version 0.10.3 Index]