read_vensim {pysd2r}

Loads a Vensim simulation file (mdl)

Description

read_vensim() calls pysd.read_vensim() and stores the object for further use. This is a key object, as it relates to a model and it can support a number of functions (e.g. model run, parameter changes)

Usage

read_vensim(o, file)

Arguments

o

is the ipysd S3 object

file

is the filename and path for the Vensim mdl file that needs to be simulated

Details

The result is used as a parameter for simulation calls.

As it's a generic function, this call is dispatched to read_vensim.isdpy

Value

An S3 object of class ipysd that will contain a reference to the model

Examples

## Not run: 
target <- system.file("models/vensim", "Population.mdl", package = "pysd2r")
py <- pysd_connect()
read_vensim(py, target)

## End(Not run)