/
README.Rmd
82 lines (45 loc) · 2.11 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
[](https://travis-ci.org/reconhub/vimes)
[](https://ci.appveyor.com/project/thibautjombart/vimes/branch/master)
[](https://codecov.io/github/reconhub/vimes?branch=master)
[](https://cran.r-project.org/package=vimes)
*vimes*: VIsualisation and Monitoring of EpidemicS
==================================================
*vimes* provides tools for integrating various types of surveillance data for
detecting disease outbreaks. This document provides an overview of the
package's content.
<br>
Installation
-------------
To install the development version from github:
```{r, install, eval=FALSE}
library(devtools)
install_github("reconhub/vimes")
```
The stable version can be installed from CRAN using:
```{r, install2, eval=FALSE}
install.packages("vimes")
```
Then, to load the package, use:
```{r, load}
library("vimes")
```
<br>
Documentation
-------------
*vimes* is fully documented on a [dedicated
website](http://www.repidemicsconsortium.org/vimes/).
It also comes with the following vignettes:
- [**`demo`**](http://www.repidemicsconsortium.org/vimes/articles/demo.html): brief overview of the package's content.
- [**`distribution`**](http://www.repidemicsconsortium.org/vimes/articles/distributions.html): details of how expected distributions of distances between cases are computed
<br>
Contributors
------------
- [Thibaut Jombart](https://github.com/thibautjombart)
- [Anne Cori](https://github.com/annecori)
See details of contributions on: <br>
https://github.com/reconhub/vimes/graphs/contributors
Contributions are welcome via **pull requests**.
Please note that this project is released with a [Contributor Code of
Conduct](CONDUCT.md). By participating in this project you agree to abide by its
terms.
**Maintainer:** Thibaut Jombart (thibautjombart@gmail.com)