README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# vistributions

> Visualize probability distributions

<!-- badges: start -->
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/vistributions)](https://cran.r-project.org/package=vistributions) 
[![R-CMD-check](https://github.com/rsquaredacademy/vistributions/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rsquaredacademy/vistributions/actions/workflows/R-CMD-check.yaml)
[![Coverage Status](https://img.shields.io/codecov/c/github/rsquaredacademy/vistributions/master.svg)](https://app.codecov.io/github/rsquaredacademy/vistributions?branch=master)  
<!-- badges: end -->

## Installation

```{r cran-installation, eval = FALSE}
# Install release version from CRAN
install.packages("vistributions")

# Install development version from GitHub
# install.packages("devtools")
devtools::install_github("rsquaredacademy/vistributions")
```

## Articles

- [Explore Distributions](https://vistributions.rsquaredacademy.com/articles/introduction-to-vistributions.html)

## Usage

```{r, echo=FALSE, message=FALSE}
library(vistributions)
```

### Normal Distribution

```{r normal}
# visualize normal distribution
vdist_normal_plot()

# visualize quantiles out of given probability
vdist_normal_perc(0.95, mean = 2, sd = 1.36, type = 'both')

# visualize probability from a given quantile
vdist_normal_prob(c(-1.74, 1.83), type = 'both')
```

## Getting Help

If you encounter a bug, please file a minimal reproducible example using 
[reprex](https://reprex.tidyverse.org/index.html) on github. For questions 
and clarifications, use [StackOverflow](https://stackoverflow.com/).