added ssd_dists_shiny()

NAMESPACE

@@ -75,6 +75,7 @@ export(ssd_data)
 export(ssd_dists)
 export(ssd_dists_all)
 export(ssd_dists_bcanz)
+export(ssd_dists_shiny)
 export(ssd_eburrIII3)
 export(ssd_ecd)
 export(ssd_ecd_data)

NEWS.md

@@ -3,6 +3,7 @@
 # ssdtools 2.2.0
 
 - Added `ssd_label_comma_hc()` function to label numbers with significant digits and comma and offset hazard concentration value if present in breaks.
+- Added `ssd_dists_shiny()` to define distributions for use in shiny app.
 - For `plot_coord_scale()` function:
   - Added `x_limits = NULL` to allow setting of x-axis limits.
   - Added `hc_value = NULL` to pass hazard concentration value.

R/dists.R

@@ -62,3 +62,18 @@ ssd_dists <- function(bcanz = NULL, tails = NULL, npars = 2:5) {
 ssd_dists_all <- function() {
   ssd_dists(bcanz = NULL, tails = NULL, npars = 2:5)
 }
+
+#' All Shiny Species Sensitivity Distributions
+#'
+#' Gets a character vector of the names of all the available distributions
+#' in the shinyssdtools.
+#'
+#' @return A unique, sorted character vector of the distributions.
+#' @family dists
+#' @export
+#'
+#' @examples
+#' ssd_dists_shiny()
+ssd_dists_shiny <- function() {
+  ssd_dists(bcanz = NULL, tails = TRUE, npars = 2:5)
+}

_pkgdown.yml

@@ -24,6 +24,7 @@ reference:
   - ssd_dists
   - ssd_dists_all
   - ssd_dists_bcanz
+  - ssd_dists_shiny
 - title: Fit
   desc: Functions that fit distributions to data
   contents: 

tests/testthat/test-dists.R

@@ -25,6 +25,16 @@ test_that("dists all", {
   )
 })
 
+test_that("dists shiny", {
+  expect_identical(
+    ssd_dists_shiny(),
+    c(
+      "burrIII3", "gamma", "gompertz", "lgumbel", "llogis",
+      "llogis_llogis", "lnorm", "lnorm_lnorm", "weibull"
+    )
+  )
+})
+
 test_that("dists all", {
   expect_identical(ssd_dists(), ssd_dists_all())
 })