ReadMe.Rmd

---
output: github_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```

# WeibullR.plotly

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/WeibullR.plotly)](https://CRAN.R-project.org/package=WeibullR.plotly)
[![CRAN checks](https://badges.cranchecks.info/summary/WeibullR.plotly.svg)](https://cran.r-project.org/web/checks/check_results_WeibullR.plotly.html)
[![](http://cranlogs.r-pkg.org/badges/last-month/WeibullR.plotly)](https://cran.r-project.org/package=WeibullR.plotly)
[![](http://cranlogs.r-pkg.org/badges/grand-total/WeibullR.plotly)](https://cran.r-project.org/package=WeibullR.plotly)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![](https://img.shields.io/badge/doi-10.32614/CRAN.package.WeibullR.plotly-green.svg)](https://doi.org/10.32614/CRAN.package.WeibullR.plotly)
<!-- badges: end -->

Build interactive Weibull Probability Plots with WeibullR, an R package for Weibull analysis, and plotly, an interactive web-based graphing library.

# Getting Started 

To install WeibullR.plotly in R:

```{r, eval=FALSE}
install.packages('WeibullR.plotly')
```

Or install the development version:

```{r, eval=FALSE}
devtools::install_github('paulgovan/weibullr.plotly')
```

# Basic Examples

To build a probability plot, first fit a `wblr` object using the `WeibullR` package and then use `plotly_wblr` to build the plot.

```{r message=FALSE, warning=FALSE}
library(WeibullR)
library(WeibullR.plotly)
failures<-c(30, 49, 82, 90, 96)
obj<-wblr.conf(wblr.fit(wblr(failures)))
plotly_wblr(obj)
```

To build a contour plot, use the `plotly_contour` function. Note that contour plots are only available where `method.fit='mle'` and `method.conf='lrb'`.

```{r message=FALSE, warning=FALSE}
obj<-wblr.conf(wblr.fit(wblr(failures), method.fit = 'mle'), method.conf = 'lrb')
plotly_contour(obj)
```

# Customization

WeibullR.plotly has several customization options.

```{r message=FALSE, warning=FALSE}
plotly_wblr(obj, main='Weibull Probability Plot', xlab='Years', ylab='Failure Probability', confCol='blue', signif=4, grid=FALSE)
```

```{r message=FALSE, warning=FALSE}
plotly_contour(obj, main='Weibull Contour Plot', col='red', signif=4, grid=FALSE)
```

## Code of Conduct

Please note that the WeibullR.plotly project is released with a [Contributor Code of Conduct](https://github.com/paulgovan/WeibullR.plotly/blob/f919aeb72a1d4dd3a64e55221eb1ae214b3480f5/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.

# More Resources

For an interactive introduction to Life Data Analysis, check out
[WeibullR.learnr](https://paulgovan.github.io/WeibullR.learnr/)

To try WeibullR.plotly in a Shiny app, check out [WeibullR.shiny](https://paulgovan.github.io/WeibullR.shiny/)