nmode's Git Repositories - Rnaught/blob - README.md

   1
   2 <!-- README.md is generated from README.Rmd. Please edit that file. -->
   3
   4 # Rnaught <a href="https://MI2YorkU.github.io/Rnaught"><img src="man/figures/logo.svg" align="right" height="139" alt="Rnaught Logo"></a>
   5
   6 Rnaught is an R package and web application for estimating the [basic
   7 reproduction number
   8 (*R*<sub>0</sub>)](https://en.wikipedia.org/wiki/Basic_reproduction_number)
   9 of infectious diseases.
  10
  11 An instance of the web application is available at
  12 <https://immune.math.yorku.ca/Rnaught>.
  13
  14 ## Installation
  15
  16 You can install the development version of Rnaught using the
  17 [devtools](https://devtools.r-lib.org) package. Run the following
  18 commands in an R session:
  19
  20 ``` r
  21 install.packages("devtools") # If not already installed.
  22 devtools::install_github("MI2YorkU/Rnaught", build_vignettes = TRUE)
  23 ```
  24
  25 ## Documentation
  26
  27 The package documentation is available online at
  28 <https://MI2YorkU.github.io/Rnaught>.
  29
  30 For a quick introduction, see the [Get
  31 started](https://MI2YorkU.github.io/Rnaught/articles/Rnaught.html) page.
  32 This can also be accessed from an R session with
  33 `vignette("Rnaught", package = "Rnaught")`.
  34
  35 To view the documentation locally, run `?Rnaught::<function>`. A list of
  36 all functions is shown in the package index by executing
  37 `help(package = "Rnaught")`.
  38
  39 ## Contributing
  40
  41 The source code for this package is available on
  42 [GitHub](https://github.com/MI2YorkU/Rnaught).
  43
  44 To report a bug, request a new feature, give feedback, or ask questions,
  45 open a new [issue](https://github.com/MI2YorkU/Rnaught/issues).
  46
  47 Submit new estimators, features, bug fixes, or patches by creating a
  48 [pull request](https://github.com/MI2YorkU/Rnaught/pulls).
  49
  50 ## License
  51
  52 This program is free software: you can redistribute it and/or modify it
  53 under the terms of the GNU Affero General Public License as published by
  54 the Free Software Foundation, either version 3 of the License, or (at
  55 your option) any later version.
  56
  57 This program is distributed in the hope that it will be useful, but
  58 WITHOUT ANY WARRANTY; without even the implied warranty of
  59 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
  60 General Public License for more details.
  61
  62 You should have received a copy of the GNU Affero General Public License
  63 along with this program. If not, see <https://www.gnu.org/licenses>.