-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
56 lines (40 loc) · 1.99 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%"
)
```
# elbow
<!-- badges: start -->
[](https://travis-ci.com/ahasverus/elbow)
[](https://ci.appveyor.com/project/ahasverus/elbow)
[](https://cran.r-project.org/package=elbow)
[](code_of_conduct.md)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://www.tidyverse.org/lifecycle/#stable)
<!-- badges: end -->
The goal of the package `elbow` is to implement the Elbow (or knee of a curve)
method to detect the inflection point of a concave curve. More information on
this method can be found on [Wikipedia](https://en.wikipedia.org/wiki/Elbow_method_(clustering)).
## Installation
You can install the `elbow` package from [GitHub](https://github.com/ahasverus/elbow) with:
```{r echo = TRUE, eval = FALSE}
devtools::install_github("ahasverus/elbow", build_vignettes = TRUE)
library(elbow)
```
## Getting started
Visit the [**vignette**](https://nicolascasajus.fr/elbow/articles/introduction.html)
for a complete example. The vignette is also available by using:
```{r echo = TRUE, eval = FALSE}
browseVignettes("elbow")
```
## Code of Conduct
Please note that the `elbow` project is released with a
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.