-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
109 lines (81 loc) · 3.12 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
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
---
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/README-",
out.width = "50%"
)
```
# visualize
<!-- badges: start -->
[](https://github.com/coatless-rpkg/visualize/actions/workflows/R-CMD-check.yaml)
[](https://www.r-pkg.org/pkg/visualize)
[](https://CRAN.R-project.org/package=visualize)
<!-- badges: end -->
The goal of visualize is to graph the pdf or pmf and highlight what area or
probability is present in user defined locations. Visualize is able to provide
lower tail, bounded, upper tail, and two tail calculations. Supports strict and
equal to inequalities. Also provided on the graph is the mean and variance of
the distribution.
## Installation
You can install the released version of visualize from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("visualize")
```
And the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("coatless/visualize")
```
## Examples
To use visualize, load the package with:
```{r}
library("visualize")
```
Then, construct a graph by following the `visualize.dist()` pattern. For example,
the normal distribution can be shown with:
```{r visualize-normal}
# Graph a standard normal distribution with a z-score of 1.96
visualize.norm(1.96)
# Change the location of the tail
visualize.norm(1.96, section = "upper")
# Create a bounded range.
visualize.norm(c(-1.96, 1.96), section = "bounded")
# Highlight both tails
visualize.norm(c(-1.96, 1.96), section = "tails")
```
The parameters of the distribution can also be modified. Take for example the
Binomial distribution.
```{r visualize-binomial}
visualize.binom(stat = 9, size = 20, p = 0.5)
# Visualize the binominal distribution with a higher size and lower probability.
visualize.binom(stat = 9, size = 24, p = 0.25)
```
Discrete distributions can also handle a level of strict (`<`, `>`) or equal
to (`<=`, `>=`) inequality.
```{r discrete-inequalities}
# Create a strict inequality (lower < x < higher)
visualize.pois(stat = c(4, 6), lambda = 3.5, section = "bounded",
strict = c(TRUE, TRUE))
# Allow for equality on either side only on the right side of the bounded region.
visualize.pois(stat = c(4, 6), lambda = 3.5, section = "bounded",
strict = c(TRUE, FALSE))
# Allow for equality on either side of the inequality (lower <= x <= higher)
visualize.pois(stat = c(4, 6), lambda = 3.5, section = "bounded",
strict = c(FALSE, FALSE))
```
## Author
James Joseph Balamuta
## Citing the `visualize` package
To ensure future development of the package, please cite `visualize`
package if used during an analysis or simulation study. Citation information
for the package may be acquired by using in *R*:
```{r, eval = FALSE}
citation("visualize")
```
## License
MIT License