-
Notifications
You must be signed in to change notification settings - Fork 105
/
Copy pathREADME.Rmd
executable file
·77 lines (51 loc) · 4.67 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit the .Rmd and knit it to generate the .md. -->
```{r, include = FALSE}
knitr::opts_chunk$set(collapse = TRUE, comment = "# >",
fig.height = 3, fig.width = 6, dpi = 96,
fig.path = "man/figures/README-")
options(tibble.print_max = 5)
library(healthcareai)
set.seed(6751)
```
# healthcareai <img src="man/figures/logo.png" align="right" />
[](https://ci.appveyor.com/project/CatalystAdmin/healthcareai-r/)
[](https://travis-ci.org/HealthCatalyst/healthcareai-r)
[](https://codecov.io/gh/HealthCatalyst/healthcareai-r)
[](https://cran.r-project.org/package=healthcareai)
[](https://cranlogs.r-pkg.org/badges/last-week/healthcareai)
[](https://github.com/HealthCatalystSLC/healthcareai-r/blob/master/LICENSE)
[](https://doi.org/10.5281/zenodo.999334)
## Overview
The aim of `healthcareai` is to make machine learning in healthcare as easy as possible. It does that by providing functions to:
- Develop customized, reliable, high-performance machine learning models with minimal code
- Easily make and evaluate predictions and push them to a database
- Understand how a model makes its predictions
- Make data cleaning, manipulation, imputation, and visualization as simple as possible
## Usage
`healthcareai` can take you from messy data to an optimized model in one line of code:
```{r, message = FALSE}
models <- machine_learn(pima_diabetes, patient_id, outcome = diabetes)
models
```
Make predictions and examine predictive performance:
```{r plot_predictions}
predictions <- predict(models, outcome_groups = TRUE)
plot(predictions)
```
## Learn More
For details on what's happening under the hood and for options to customize data preparation and model training, see [Getting Started with healthcareai](https://docs.healthcare.ai/articles/site_only/healthcareai.html) as well as the helpfiles for individual functions such as `?machine_learn`, `?predict.model_list`, and `?explore`.
Documentation of all functions as well as vignettes on various uses of the package are available at the package website: https://docs.healthcare.ai/.
Also, be sure to read our [blog](http://healthcare.ai/blog/) and watch our [broadcasts](https://www.youtube.com/channel/UCGZUobs_x712KbcL6RSzfnQ) to learn more about what's new in healthcare machine learning and how we are using this toolkit to put machine learning to work in real healthcare systems.
## Get Involved
We have a [Slack community](https://healthcare-ai.slack.com/) that is a great place to introduce yourself, share what you're doing with the package, ask questions, and troubleshoot your code.
### Contributing
If you are interested in contributing the package (great!), please read the [contributing](https://github.com/HealthCatalyst/healthcareai-r/blob/master/CONTRIBUTING.md) guide, and look for [issues with the "help wanted" tag](https://github.com/HealthCatalyst/healthcareai-r/labels/help%20wanted). Feel free to tackle any issue that interests you; those are a few issues that we feel would make a good place to start.
### Feedback
Your feedback is hugely appreciated. It is makes the package work well and helps us make it more useful to the community. Both feature requests and bug reports should be submitted as [Github issues](https://github.com/HealthCatalyst/healthcareai-r/issues/new).
**Bug reports** should be filed with a [minimal reproducable example](https://gist.github.com/hadley/270442). The [reprex package](https://github.com/tidyverse/reprex) is extraordinarily helpful for this. Please also include the output of `sessionInfo()` or better yet, `devtools::session_info()`.
## Legacy
Version 1 of `healthcareai` has been retired. You can continue to use it, but its compatibility with changes in the R ecosystem are not guaranteed. You should always be able to install it from github with: `install.packages("remotes"); remotes::install_github("HealthCatalyst/[email protected]")`.
For an example of how to adapt v1 models to the v2 API, check out the [Transitioning vignettes](https://docs.healthcare.ai/articles/site_only/transitioning.html).