-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.Rmd
More file actions
143 lines (106 loc) · 3.74 KB
/
Copy pathREADME.Rmd
File metadata and controls
143 lines (106 loc) · 3.74 KB
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
---
title: "triangle"
output:
md_document:
variant: gfm
---
<!-- DO NOT EDIT: README.md is created from README.Rmd -->
<div>
<table style="border: 0">
<tr>
<td>
<img align="left" width="200" height="200" src="man/figures/logo.svg"/>
</td>
</tr>
</table>
</div>
<footer>© Copyright 2024 Robert Carnell</footer>
```{r setup, echo=FALSE, include=FALSE}
require(knitr)
require(triangle)
knitr::opts_chunk$set(fig.path = "man/figures/")
```
# triangle
An R package to work with the triangle distribution and logarithmic triangle distribution
```{r badges, echo=FALSE, results = 'asis'}
print_header_badges <- function(header_vec, badge_vec) {
stopifnot(length(header_vec) == length(badge_vec))
c(paste0("|<sub>", paste0(header_vec, collapse="</sub>|<sub>"), "</sub>|\n"),
paste0("|", paste0(rep(":---:", length(header_vec)), collapse="|"), "|\n"),
paste0("|", paste0(badge_vec, collapse="|"), "|\n"))
}
header_vec <- c("Actions", "Code Coverage", "Website", "CRAN Downloads", "CRAN")
badge_vec <- c(
"[](https://github.com/bertcarnell/triangle/actions/workflows/r-cmd-check.yml)",
"[](https://codecov.io/github/bertcarnell/triangle?branch=master)",
"[](https://bertcarnell.github.io/triangle/)",
"[](https://cran.r-project.org/package=triangle)",
"[](https://cran.r-project.org/package=triangle)")
cat(print_header_badges(header_vec, badge_vec))
cat("\n")
header_vec <- c("R-Universe", "CRAN Packages", "DOI")
badge_vec <- c(
"[](https://bertcarnell.r-universe.dev/)",
"[](https://cran.r-project.org/web/checks/check_results_bertcarnell_at_gmail.com.html)",
"[](https://cran.r-project.org/package=triangle)"
)
cat(print_header_badges(header_vec, badge_vec))
```
See the package documentation [here:](https://bertcarnell.github.io/triangle/)
## Getting Started
Install the R package:
```{r echo=TRUE, eval=FALSE}
# Stable CRAN version
install.packages("triangle")
# OR development version from GitHub
require(devtools)
devtools::install_github("bertcarnell/triangle")
```
use the functions:
- `a` = minimum
- `b` = maximum
- `c` = mode
```{r echo=TRUE, eval=FALSE}
require(triangle)
```
### Triangle distribution
```{r echo=TRUE}
# rtriangle(n, a, b, c)
set.seed(42)
rtriangle(5, 1, 5, 2)
# ptriangle(x, a, b, c)
ptriangle(0:5, 0, 10, 5)
# qtriangle(p, a, b, c)
qtriangle(seq(0, 1, by = 0.2), 1, 10, 3)
# dtriangle(x, a, b, c)
dtriangle(0:4, 0, 10, 5)
```
### Logarithmic triangle distribution
```{r echo=TRUE}
# rltriangle(n, a, b, c, logbase)
set.seed(2001)
rltriangle(5, 1, 100, 10)
# pltriangle(x, a, b, c, logbase)
pltriangle(10^(0:3), 1, 1000, 10)
# qltriangle(p, a, b, c, logbase)
qltriangle(seq(0, 1, by = 0.2), 1, 100, 20)
# dltriangle(x, a, b, c, logbase)
dltriangle(0:5, 1, 10, 5)
```
### Parameter estimates
#### triangle method of moments estimates
```{r echo=TRUE}
x <- rtriangle(20, 0, 2, 1.5)
triangle_mom(x)
```
#### triangle maximum likelihood estimates
```{r echo=TRUE}
x <- c(0.1, 0.25, 0.3, 0.4, 0.45, 0.6, 0.75, 0.8)
# triangle_mle(x, debug = FALSE, maxiter = 100)
triangle_mle(x)
# standard triangle (0,1) likelihood estimates
standard_triangle_mle(x)
set.seed(1976)
x <- rtriangle(100, 1, 5, 3.5)
triangle_mle(x)
```