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