Rnaught

An R package and web application for estimating the basic reproduction number (R0) of infectious diseases.

https://github.com/mi2yorku/rnaught

Keywords

Repository

An R package and web application for estimating the basic reproduction number (R0) of infectious diseases.

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

# Rnaught 


[![R-CMD-check](https://github.com/MI2YorkU/Rnaught/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/MI2YorkU/Rnaught/actions/workflows/R-CMD-check.yaml)


Rnaught is an R package and web application for estimating the
[basic reproduction number (*R*0)](
https://en.wikipedia.org/wiki/Basic_reproduction_number) of infectious diseases.

An instance of the web application is available at
.


## Installation

### Latest CRAN release

``` r
install.packages("Rnaught")
```

### Development version

``` r
install.packages("devtools") # If not already installed.
devtools::install_github("MI2YorkU/Rnaught", build_vignettes = TRUE)
```


## Documentation

The package documentation is available online at
.

For a quick introduction, see the [Get started](
https://mi2yorku.github.io/Rnaught/articles/Rnaught.html) page. This can also be
accessed from an R session with `vignette("Rnaught", package = "Rnaught")`.

To view the documentation locally, run `?Rnaught::`. A list of all
functions is shown in the package index by executing
`help(package = "Rnaught")`.


## Contributing

The source code for this package is available on
[GitHub](https://github.com/MI2YorkU/Rnaught). 

To report a bug, request a new feature, give feedback, or ask questions, open a
new [issue](https://github.com/MI2YorkU/Rnaught/issues).

Submit new estimators, features, bug fixes, or patches by creating a
[pull request](https://github.com/MI2YorkU/Rnaught/pulls).


## License

Copyright © 2022 - 2025 [Rnaught contributors](
https://github.com/MI2YorkU/Rnaught/graphs/contributors)

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along
with this program. If not, see .

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
message: 'To cite package "Rnaught" in publications use:'
type: software
license: AGPL-3.0-or-later
title: 'Rnaught: Estimate the Basic Reproduction Number (R0) of Infectious Diseases'
abstract: An R package and web application for estimating the basic reproduction
  number (R0) of infectious diseases.
authors:
- family-names: Model
  given-names: Naeem
  email: me@nmode.ca
- family-names: Boonpatcharanon
  given-names: Sawitree
- family-names: Heffernan
  given-names: Jane
- family-names: Jankowski
  given-names: Hanna
- family-names: Krikella
  given-names: Tatiana
repository-code: 'https://github.com/MI2YorkU/Rnaught'
url: 'https://MI2YorkU.github.io/Rnaught'
contact:
- family-names: Model
  given-names: Naeem
  email: me@nmode.ca

GitHub Events

Packages