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