Skip to content

In-development R package to nowcast right-truncated epidemiological data

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md
Notifications You must be signed in to change notification settings

epinowcast/baselinenowcast

Repository files navigation

Baseline nowcast (in development)

Lifecycle: stable R-CMD-check Codecov test coverage MIT license GitHub contributors

Summary

Nowcasting right-truncated epidemiological data is critical for timely public health decision-making, as reporting delays can create misleading impressions of declining trends in recent data. This package provides simple nowcasting methods for practical use based on using empirical delay distributions and uncertainty from past performance. It is also designed to be used as a baseline method for developers of new nowcasting methods. It supports standard data frame inputs with reference date, report date, and count columns, is compatible with ‘epinowcast’ objects, and also supports direct use of reporting triangles. Alongside an opinionated default workflow, it has a low-level pipe-friendly modular interface, allowing context-specific workflows. It can accommodate a wide spectrum of reporting schedules, including mixed patterns of reference and reporting (daily-weekly, weekly-daily). It also supports sharing delay distributions and uncertainty estimates between strata, as well as custom uncertainty models and delay estimation methods.

Installation

Installing the package

To install the development version from GitHub (warning! this version may contain breaking changes and/or bugs), use the pak package:

pak::pak(file.path("epinowcast", "baselinenowcast"))

Resources

We provide a range of other documentation, case studies, and community spaces to ask (and answer!) questions:

Organisation Website

Our organisation website includes links to other resources, guest posts, and seminar schedule for both upcoming and past recordings.

Community Forum

Our community forum has areas for question and answer and considering new methods and tools, among others. If you are generally interested in real-time analysis of infectious disease, you may find this useful even if you do not use baselinenowcast.

Contributing

We welcome contributions and new contributors! We particularly appreciate help on identifying and identified issues. Please check and add to the issues, and/or add a pull request and see our contributing guide for more information.

How to make a bug report or feature request

Please briefly describe your problem and what output you expect in an issue. See our contributing guide for more information.

Code of Conduct

Please note that the baselinenowcast project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Citation

If you use baselinenowcast in your work, please consider citing it with citation("baselinenowcast").

Contributors

All contributions to this project are gratefully acknowledged using the allcontributors package following the allcontributors specification. Contributions of any kind are welcome!

Code

kaitejohnson, seabbs, sbfnk

Issue Authors

jonathonmellor

Issue Contributors

jbracher, TimTaylor

About

In-development R package to nowcast right-truncated epidemiological data

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published