Update docs

paulgovan · May 31, 2023 · 8fc2c97 · 8fc2c97
1 parent e83f204
commit 8fc2c97
Show file tree

Hide file tree

Showing 15 changed files with 63 additions and 98 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -10,7 +10,7 @@
 ^pkgdown$
 ^\.github$
 ^index\.md$
-^news\.md$
+^NEWS\.md$
 ^vignettes/OtherExamples\.html$
 ^vignettes$
 ^CRAN-SUBMISSION$

diff --git a/.Rproj.user/BC46F668/sources/prop/1F64CA30 b/.Rproj.user/BC46F668/sources/prop/1F64CA30
@@ -1,6 +1,6 @@
 {
     "source_window_id": "",
     "Source": "Source",
-    "cursorPosition": "56,16",
-    "scrollLine": "49"
+    "cursorPosition": "72,31",
+    "scrollLine": "59"
 }
diff --git a/.Rproj.user/BC46F668/sources/prop/9A2BABEB b/.Rproj.user/BC46F668/sources/prop/9A2BABEB
@@ -2,6 +2,6 @@
     "tempName": "Untitled1",
     "source_window_id": "",
     "Source": "Source",
-    "cursorPosition": "1,14",
-    "scrollLine": "0"
+    "cursorPosition": "65,1",
+    "scrollLine": "54"
 }
diff --git a/.Rproj.user/BC46F668/sources/prop/FC30B8EE b/.Rproj.user/BC46F668/sources/prop/FC30B8EE
@@ -1,6 +1,6 @@
 {
     "source_window_id": "",
     "Source": "Source",
-    "cursorPosition": "17,9",
-    "scrollLine": "1"
+    "cursorPosition": "12,5",
+    "scrollLine": "0"
 }
diff --git a/.Rproj.user/BC46F668/sources/prop/INDEX b/.Rproj.user/BC46F668/sources/prop/INDEX
@@ -1,6 +1,7 @@
 ~%2FDocuments%2FWeibullR.plotly%2F.Rbuildignore="FC30B8EE"
 ~%2FDocuments%2FWeibullR.plotly%2FDESCRIPTION="D34D33AF"
 ~%2FDocuments%2FWeibullR.plotly%2FNAMESPACE="0AF9AEB6"
+~%2FDocuments%2FWeibullR.plotly%2FNEWS.md="A3E6F897"
 ~%2FDocuments%2FWeibullR.plotly%2FR%2FWeibullR.plotly.R="CDE87BB8"
 ~%2FDocuments%2FWeibullR.plotly%2FR%2Fhello.R="6088C3A5"
 ~%2FDocuments%2FWeibullR.plotly%2FR%2Fplotly_contour.R="BEDBBA09"

diff --git a/.Rproj.user/shared/notebooks/4277643B-ReadMe/1/s/chunks.json b/.Rproj.user/shared/notebooks/4277643B-ReadMe/1/s/chunks.json
@@ -1 +1 @@
-{"chunk_definitions":[],"doc_write_time":1683847480}
+{"chunk_definitions":[],"doc_write_time":1685549553}
diff --git a/.Rproj.user/shared/notebooks/paths b/.Rproj.user/shared/notebooks/paths
@@ -1,6 +1,7 @@
 /Users/paulgovan/Documents/WeibullR.plotly/.Rbuildignore="F38CA4FE"
 /Users/paulgovan/Documents/WeibullR.plotly/DESCRIPTION="BC434E15"
 /Users/paulgovan/Documents/WeibullR.plotly/NAMESPACE="60DF5FF4"
+/Users/paulgovan/Documents/WeibullR.plotly/NEWS.md="8CC4916B"
 /Users/paulgovan/Documents/WeibullR.plotly/R/plotly_contour.R="6F41557C"
 /Users/paulgovan/Documents/WeibullR.plotly/R/plotly_wblr.R="7798E39E"
 /Users/paulgovan/Documents/WeibullR.plotly/ReadMe.Rmd="4277643B"

diff --git a/ReadMe.Rmd b/ReadMe.Rmd
@@ -6,19 +6,33 @@ output: github_document
 knitr::opts_chunk$set(echo = TRUE)
 ```
 
-## WeibullR.plotly
+# WeibullR.plotly
 
-WeibullR.plotly is a simple R package for building interactive Weibull Probability Plots. This package depends on WeibullR, a R package for Weibull analysis, and plotly, an interactive web-based graphing library.
+<!-- badges: start -->
+[![CRAN status](https://www.r-pkg.org/badges/version/WeibullR.plotly)](https://CRAN.R-project.org/package=WeibullR.plotly)
+![](http://cranlogs.r-pkg.org/badges/grand-total/WeibullR.plotly)
+![](http://cranlogs.r-pkg.org/badges/WeibullR.plotly)
+[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![Launch binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/paulgovan/WeibullR.plotly/main)
+<!-- badges: end -->
 
-## Getting Started 
+Build interactive Weibull Probability Plots with WeibullR, an R package for Weibull analysis, and plotly, an interactive web-based graphing library.
 
-WeibullR.plotly is still in development. To install the developmental version in R:
+# 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
+# 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.
 
@@ -37,7 +51,7 @@ obj<-wblr.conf(wblr.fit(wblr(failures), method.fit = 'mle'), method.conf = 'lrb'
 plotly_contour(obj)
 ```
 
-## Customization
+# Customization
 
 WeibullR.plotly has several customization options.
 
@@ -49,7 +63,7 @@ plotly_wblr(obj, main='Weibull Probability Plot', xlab='Years', ylab='Failure Pr
 plotly_contour(obj, main='Weibull Contour Plot', col='red', signif=4, grid=FALSE)
 ```
 
-## More Resources
+# More Resources
 
 For an interactive introduction to Life Data Analysis, check out
 [WeibullR.learnr](https://paulgovan.github.io/WeibullR.learnr/)

diff --git a/ReadMe.md b/ReadMe.md
@@ -1,20 +1,36 @@
 
-## WeibullR.plotly
+# WeibullR.plotly
 
-A simple R package for building interactive Weibull
-Probability Plots that depends on WeibullR, a R package for
-Weibull analysis, and plotly, an interactive web-based graphing library.
+<!-- badges: start -->
 
-## Getting Started
+[![CRAN
+status](https://www.r-pkg.org/badges/version/WeibullR.plotly)](https://CRAN.R-project.org/package=WeibullR.plotly)
+![](http://cranlogs.r-pkg.org/badges/grand-total/WeibullR.plotly)
+![](http://cranlogs.r-pkg.org/badges/WeibullR.plotly) [![Lifecycle:
+experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![Launch
+binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/paulgovan/WeibullR.plotly/main)
+<!-- badges: end -->
 
-WeibullR.plotly is still in development. To install the developmental
-version in R:
+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
+install.packages('WeibullR.plotly')
+```
+
+Or install the development version:
 
 ``` r
 devtools::install_github('paulgovan/weibullr.plotly')
 ```
 
-## Basic Examples
+# 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.
@@ -27,7 +43,7 @@ obj<-wblr.conf(wblr.fit(wblr(failures)))
 plotly_wblr(obj)
 ```
 
-![](ReadMe_files/figure-gfm/unnamed-chunk-2-1.png)<!-- -->
+![](man/figures/unnamed-chunk-2-1.png)<!-- -->
 
 To build a contour plot, use the `plotly_contour` function. Note that
 contour plots are only available where `method.fit='mle'` and
@@ -38,25 +54,25 @@ obj<-wblr.conf(wblr.fit(wblr(failures), method.fit = 'mle'), method.conf = 'lrb'
 plotly_contour(obj)
 ```
 
-![](ReadMe_files/figure-gfm/unnamed-chunk-3-1.png)<!-- -->
+![](man/figures/unnamed-chunk-3-1.png)<!-- -->
 
-## Customization
+# Customization
 
 WeibullR.plotly has several customization options.
 
 ``` r
 plotly_wblr(obj, main='Weibull Probability Plot', xlab='Years', ylab='Failure Probability', col='blue', signif=4, grid=FALSE)
 ```
 
-![](ReadMe_files/figure-gfm/unnamed-chunk-4-1.png)<!-- -->
+![](man/figures/unnamed-chunk-4-1.png)<!-- -->
 
 ``` r
 plotly_contour(obj, main='Weibull Contour Plot', col='red', signif=4, grid=FALSE)
 ```
 
-![](ReadMe_files/figure-gfm/unnamed-chunk-5-1.png)<!-- -->
+![](man/figures/unnamed-chunk-5-1.png)<!-- -->
 
-## More Resources
+# More Resources
 
 For an interactive introduction to Life Data Analysis, check out
 [WeibullR.learnr](https://paulgovan.github.io/WeibullR.learnr/)

diff --git a/ReadMe_files/figure-gfm/unnamed-chunk-3-1.png b/ReadMe_files/figure-gfm/unnamed-chunk-3-1.png
diff --git a/ReadMe_files/figure-gfm/unnamed-chunk-4-1.png b/ReadMe_files/figure-gfm/unnamed-chunk-4-1.png
diff --git a/ReadMe_files/figure-gfm/unnamed-chunk-5-1.png b/ReadMe_files/figure-gfm/unnamed-chunk-5-1.png
diff --git a/ReadMe_files/figure-gfm/unnamed-chunk-6-1.png b/ReadMe_files/figure-gfm/unnamed-chunk-6-1.png
diff --git a/index.md b/index.md
diff --git a/news.md b/news.md
@@ -1,8 +1,6 @@
-# WeibullR.plotly 0.1.2
-
-# WeibullR.plotly 0.1.1
+# WeibullR.plotly (development version)
 
-# WeibullR.plotly v0.1
+# WeibullR.plotly 0.1.2
 
 ## Initial release
 * plotly_wblr function
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"chunk_definitions":[],"doc_write_time":1683847480}
		{"chunk_definitions":[],"doc_write_time":1685549553}