forked from avalcarcel9/mimosa
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
52 lines (29 loc) · 2.21 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
# mimosa <img src="sticker.png" width = "150" align="right" />
The `mimosa` package trains and makes predictions from the MIMoSA method. Access to the full papers can be found [here](https://onlinelibrary.wiley.com/doi/abs/10.1111/jon.12506) and [here](https://doi.org/10.1016/j.nicl.2018.10.013). Additionally, it allows for implementation of some common segmentation metrics such as true positive rate, false positive rate, false negative rate, false positive count, and sensitivity based on lesion count.
## Installation
To install the package from Neuroconductor, type:
```{r, eval = FALSE}
source("https://neuroconductor.org/neurocLite.R")
neuro_install("mimosa")
```
To get the latest development version from GitHub:
```{r, eval = FALSE}
devtools::install_github('avalcarcel9/mimosa')
```
avalcarcel9 badges:
[![Travis-CI Build Status](https://travis-ci.org/avalcarcel9/mimosa.svg?branch=master)](https://travis-ci.org/avalcarcel9/mimosa)
<!-- [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/avalcarcel9/mimosa?branch=master&svg=true)](https://ci.appveyor.com/project/avalcarcel9/mimosa) -->
[![Coverage status](https://coveralls.io/repos/github/avalcarcel9/mimosa/badge.svg?branch=master)](https://coveralls.io/r/avalcarcel9/mimosa?branch=master)
muschellij2 badges:
[![Travis-CI Build Status](https://travis-ci.org/avalcarcel9/mimosa.svg?branch=master)](https://travis-ci.org/muschellij2/mimosa)
<!-- [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/muschellij2/mimosa?branch=master&svg=true)](https://ci.appveyor.com/project/muschellij2/mimosa) -->
[![Coverage status](https://coveralls.io/repos/github/muschellij2/mimosa/badge.svg)](https://coveralls.io/r/muschellij2/mimosa?branch=master)
## Package Documentation
Check out our `pkgdown` site [here](https://avalcarcel9.github.io/mimosa/).
Full functions and documentation references are available [here](https://avalcarcel9.github.io/mimosa/reference/index.html).
## Vignette
For a full implementation of the methods with output please see our [vignette](https://avalcarcel9.github.io/mimosa/articles/mimosa.html).