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

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