Skip to contents

Create an object for containing a compartmental model.

Usage

Compartmental(model_directory)

Arguments

model_directory

String giving a path to a directory containing the following files, variables.csv, derivations.json, flows.csv, and settings.json, described by this spec.

Value

An object with the following methods and fields.

Methods

  • $variables$all(): Partition object of all variables.

  • $flows(): Data frame with rows giving all groups of flows.

  • $flows_expanded(): Data frame with rows giving all individual flows.

  • $variables$state(): Partition object of all state variables.

  • $variables$flow(): Partition object of all flow variables.

  • $all_labels(): Character vector giving the labels of all variables.

  • $labels$state(): Character vector giving the labels of all state variables.

  • $labels$flow(): Character vector giving the labels of all flow variables.

  • $labels$other(): Character vector giving the labels of all variables that are neither state nor flow variables.

  • $expr_list(): ExprList object containing all expressions.

Fields

  • $def: The ModelFiles object representing the directory that defines the model.

  • $simulators: A Simulators instance containing methods for generating simulators, which are objects that can generate simulations from the model.