X-Git-Url: https://git.nmode.ca/Rnaught/blobdiff_plain/12ec5983556b900dfe0abbd8b55b4fb2bc84a050..d8959fe09568137aeceb0be19a955b981010c3c4:/index.html diff --git a/index.html b/index.html index 6c6d173..b1bcdc1 100644 --- a/index.html +++ b/index.html @@ -5,14 +5,19 @@ -Estimate the Basic Reproduction Number of Infectious Diseases • Rnaught +Estimate the Basic Reproduction Number (R0) of Infectious Diseases • Rnaught + + + + + - - - - - + + + + + @@ -32,6 +37,7 @@ + +

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

-

In progress…

+

An instance of the web application is available at https://immune.math.yorku.ca/Rnaught.

+
+

Installation +

+

You can install the development version of Rnaught using the devtools package. Run the following commands in an R session:

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

Documentation +

+

The package documentation is available online at https://MI2YorkU.github.io/Rnaught.

+

For a quick introduction, see the Get started page. This can also be accessed from an R session with vignette("Rnaught", package = "Rnaught").

+

To view the documentation locally, run ?Rnaught::<function>. 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.

+

To report a bug, request a new feature, give feedback, or ask questions, open a new issue.

+

Submit new estimators, features, bug fixes, or patches by creating a pull request.

+
+
+

License +

+

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 https://www.gnu.org/licenses.

+