COVID19IBM

<p>Environment subclass representing a COVID19 outbreak as defined
in the COVID19-IBM model.</p>
<p>See <code><a rd-options="" href="/link/Simulation?package=OpenABMCovid19&version=1.0.1" data-mini-rdoc="OpenABMCovid19::Simulation">Simulation</a></code> for examples.</p>


OpenABM-Covid19 is an agent-based model (ABM) developed to simulate the spread
of COVID-19 in a city and to analyse the effect of both passive and active
intervention strategies. Interactions between individuals are modelled on
networks representing households, work-places and random contacts. The
infection is transmitted between these contacts and the progression of the
disease in individuals is modelled. Instantaneous contract-tracing and
quarantining of contacts is modelled allowing the evaluation of the design and
configuration of digital contract-tracing mobile phone apps.
Robert Hinch, William J M Probert, et al. (2020) <doi:10.1101/2020.09.16.20195925>.

Oli Legat

OpenABMCovid19

Agent-Based Model for Modelling the COVID-19

Robert Hinch

Will Probert

Ana Bulas Cruz

Andrea Stewart

Anel Nurtay

Anthony Finkelstein

Ares Meroueh

Arun Lobo

Bryn Mathias

Chris Wymant

Christophe Fraser

Daniel Montero

David G Bonsall

Evan Blumgart

Feifan Chen

Felix Breuer

James Lockyer

James Warren

Katrina Lythgoe

Kelvin Van Vurren

Lele Zhao

Luca Ferretti

Lucie Abeler-D<c3><b6>rner

Matthew Abueg

Matthew Hall

Michelle Kendall

Neo Wu

Nicole Mather

Ross Boylan

Scott Stevenson

Setrak Balian

feldnerd 

mattea 

neozwu 

rory-improbable 

COVID19IBM function

<p><code><a rd-options="OpenABMCovid19:Environment" href="/link/OpenABMCovid19%3A%3AEnvironment?package=OpenABMCovid19&version=1.0.1&to=OpenABMCovid19%3AEnvironment" data-mini-rdoc="OpenABMCovid19:Environment::OpenABMCovid19::Environment">OpenABMCovid19::Environment</a></code> -&gt; <code>COVID19IBM</code></p>

Super class

<p></p><dl class="dl-horizontal">
<dt><code>model</code></dt><dd><p>An instance of the <code><a rd-options="" href="/link/Model?package=OpenABMCovid19&version=1.0.1" data-mini-rdoc="OpenABMCovid19::Model">Model</a></code> class.</p></dd>
</dl><p></p>

Public fields

<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/COVID19IBM%24new()?package=OpenABMCovid19&version=1.0.1" data-mini-rdoc="OpenABMCovid19::COVID19IBM$new()"><code>COVID19IBM$new()</code></a></p></li>
<li><p><a href="/link/COVID19IBM%24start_simulation()?package=OpenABMCovid19&version=1.0.1" data-mini-rdoc="OpenABMCovid19::COVID19IBM$start_simulation()"><code>COVID19IBM$start_simulation()</code></a></p></li>
<li><p><a href="/link/COVID19IBM%24end_simulation()?package=OpenABMCovid19&version=1.0.1" data-mini-rdoc="OpenABMCovid19::COVID19IBM$end_simulation()"><code>COVID19IBM$end_simulation()</code></a></p></li>
<li><p><a href="/link/COVID19IBM%24step()?package=OpenABMCovid19&version=1.0.1" data-mini-rdoc="OpenABMCovid19::COVID19IBM$step()"><code>COVID19IBM$step()</code></a></p></li>
</ul>
</p><p><ul>
<li><p><a href="/link/OpenABMCovid19%3A%3AEnvironment%24start()?package=OpenABMCovid19&version=1.0.1" data-mini-rdoc="OpenABMCovid19::OpenABMCovid19::Environment$start()"><code>OpenABMCovid19::Environment$start()</code></a></p></li>
</ul></p><h3>Method <code>new()</code></h3><p></p><p>Environment subclass representing a COVID19 outbreak as
defined in the COVID19-IBM model
</p><h3>Usage</h3><p></p><p><pre>COVID19IBM$new(model, ...)</pre></p><p></p><h3>Arguments</h3><p></p><p><dl class="dl-horizontal">
<dt><code>model</code></dt><dd><p>An R6 <code><a rd-options="" href="/link/Model?package=OpenABMCovid19&version=1.0.1" data-mini-rdoc="OpenABMCovid19::Model">Model</a></code> class instance.</p></dd></dl></p><p><dt><code>...</code></dt><dd><p>Parameters to pass to Environment super class.</p></dd>
</p><p></p><p></p><h3>Method <code>start_simulation()</code></h3><p></p><p>Start a simulation.
</p><h3>Usage</h3><p></p><p><pre>COVID19IBM$start_simulation()</pre></p><p></p><h3>Returns</h3><p></p><p>The state of the system</p><p></p><p></p><h3>Method <code>end_simulation()</code></h3><p></p><p>End the simulation. Destroy the model.
</p><h3>Usage</h3><p></p><p><pre>COVID19IBM$end_simulation()</pre></p><p></p><p></p><h3>Method <code>step()</code></h3><p></p><p>Run the simulation through one time step.
</p><h3>Usage</h3><p></p><p><pre>COVID19IBM$step(action)</pre></p><p></p><h3>Arguments</h3><p></p><p><dl class="dl-horizontal">
<dt><code>action</code></dt><dd><p>Vector of actions. The vector should contain names from
<code><a rd-options="" href="/link/SAFE_UPDATE_PARAMS?package=OpenABMCovid19&version=1.0.1" data-mini-rdoc="OpenABMCovid19::SAFE_UPDATE_PARAMS">SAFE_UPDATE_PARAMS</a></code></p></dd>
</dl></p><p></p><h3>Returns</h3><p></p><p>The state of the system.</p>

Methods

<p>Environment subclass representing a COVID19 outbreak as defined
in the COVID19-IBM model.</p>
<p>See <code><a rd-options='' href='Simulation'>Simulation</a></code> for examples.</p>

R6Class COVID19IBM — COVID19IBM

<p><code><a rd-options='OpenABMCovid19:Environment' href='OpenABMCovid19::Environment'>OpenABMCovid19::Environment</a></code> -&gt; <code>COVID19IBM</code></p>

<p></p><dl class='dl-horizontal'>
<dt><code>model</code></dt><dd><p>An instance of the <code><a rd-options='' href='Model'>Model</a></code> class.</p></dd>
</dl><p></p>

R6Class COVID19IBM

COVID19IBM: R6Class COVID19IBM

Description

Arguments

Super class

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `start_simulation()`

Usage

Returns

Method `end_simulation()`

Usage

Method `step()`

Usage

Arguments

Returns

Description

Arguments

Super class

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method start_simulation()

Usage

Returns

Method end_simulation()

Usage

Method step()

Usage

Arguments

Returns

Method `new()`

Method `start_simulation()`

Method `end_simulation()`

Method `step()`