README.md

Smidm - Statistical Modelling for Infectious Disease Management

Project Status: Active – The project has reached a stable, usable
state and is being actively
developed. pipeline
status coverage
report CRAN
status

Overview

Smidm implements statistical models and visualizations to support decision making by health authorities w.r.t. the COVID-19 pandemic. The application can be viewed here.

Installation

This package can be installed for developers with access to this repository with this command:

install.packages(c("devtools", "rmarkdown"))
devtools::install_git(
  "https://gitlab.cc-asp.fraunhofer.de/ester/smidm.git",
  ref = "main",
  build_vignettes = TRUE
  )

The ref argument can be used to specify which version/branch should be installed.

Getting started

Several vignettes have been compiled to illustrate the functionality of the package. An overview can be displayed via:

vignette(package = "smidm")

To display an individual vignette, e.g. for the prediction when contacts of an infected person will start to show symptoms, utilize the following command:

vignette(topic = "contacts", package = "smidm")

Conventions

As style guide for this project the tidyverse style guide is used.

Version numbers of the package are given by the Semantic Versioning.

The default branch is main. For adding new features, you need to create a new branch. On the main branch is no pushing, only merging.

Development and research

The research project was funded from 15.05.2020 - 14.12.2020 within the Fraunhofer Anti-Corona Program and from 01.07.2021 - 30.06.2022 within the program Prevention and Care of Epidemic Infections with Innovative Medical Technology by the Federal Ministry of Education and Research.

In addition to the R-package a web application was built, which is available at https://ester.fraunhofer.de/.

Authors and contact

The project was developed by Fraunhofer Institute for Industrial Mathematics ITWM, Fraunhofer Institute for Digital Medicine MEVIS and Leibniz Institute for Prevention Research and Epidemiology BIPS in cooperation with the health authority Berlin-Reinickendorf.

If you have any questions, feedback, issues/PR, you can contact us via ester-info@itwm.fraunhofer.de.

For further contact information, please visit the website https://www.itwm.fraunhofer.de/en/departments/fm/data-science.html.

License

Licensed under the BSD 3-Clause License.



Try the smidm package in your browser

Any scripts or data that you put into this service are public.

smidm documentation built on Aug. 27, 2022, 9:06 a.m.