Diff of /README.md [000000] .. [242173]

Switch to unified view

a b/README.md
1
2
<!-- README.md is generated from README.Rmd. Please edit that file -->
3
4
ichseg <img src="man/figures/logo.png" align="right" height="139" />
5
====================================================================
6
7
<!-- badges: start -->
8
9
[![Travis build
10
status](https://travis-ci.com/muschellij2/ichseg.svg?branch=master)](https://travis-ci.com/muschellij2/ichseg)
11
[![AppVeyor build
12
status](https://ci.appveyor.com/api/projects/status/github/muschellij2/ichseg?branch=master&svg=true)](https://ci.appveyor.com/project/muschellij2/ichseg)
13
<!-- badges: end -->
14
15
The goal of `ichseg` is to perform preprocessing on computed tomography
16
(CT) scans, including skull stripping. Computes predictors of
17
intracerebral hemorrhage (ICH) and uses these to predict a binary
18
hemorrhage mask from the data.
19
20
Citing
21
------
22
23
To cite `ichseg`, you can run:
24
25
    citation("ichseg")
26
27
    Muschelli J, Sweeney EM, Ullman NL, Vespa P, Hanley DF, Crainiceanu CM
28
    (2017). "PItcHPERFeCT: Primary Intracranial Hemorrhage Probability
29
    Estimation using Random Forests on CT." _NeuroImage: Clinical_, *14*,
30
    379-390.
31
32
    A BibTeX entry for LaTeX users is
33
34
      @Article{muschelli2017pitchperfect,
35
        title = {{PItcHPERFeCT}: Primary Intracranial Hemorrhage Probability Estimation using Random Forests on {CT}},
36
        author = {John Muschelli and Elizabeth M Sweeney and Natalie L Ullman and Paul Vespa and Daniel F Hanley and Ciprian M Crainiceanu},
37
        journal = {NeuroImage: Clinical},
38
        volume = {14},
39
        pages = {379--390},
40
        year = {2017},
41
        publisher = {Elsevier},
42
      }
43
44
Installation
45
------------
46
47
You can install `ichseg` from github with:
48
49
    # install.packages("devtools")
50
    devtools::install_github("muschellij2/ichseg")
51
52
Requirements
53
------------
54
55
These functions require a working installation of FSL
56
(<a href="https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FslInstallation" class="uri">https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FslInstallation</a>),
57
which can be installed via Neurodebian as well:
58
<a href="http://neuro.debian.net/pkgs/fsl-complete.html" class="uri">http://neuro.debian.net/pkgs/fsl-complete.html</a>.
59
60
Prediction
61
----------
62
63
In order to segment ICH from an image, use the `ich_segment` function:
64
65
    ichseg::ich_segment(img = "/path/to/ct/scan")