- licensing_md() to - ssd_licensing_md().

open-AIMS · May 23, 2024 · 2ae0363 · 2ae0363
1 parent efd325d
commit 2ae0363
Show file tree

Hide file tree

Showing 14 changed files with 17 additions and 461 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -55,7 +55,6 @@ export(geom_xribbon)
 export(glance)
 export(is.fitdists)
 export(is_censored)
-export(licensing_md)
 export(logLik)
 export(nobs)
 export(npars)
@@ -97,6 +96,7 @@ export(ssd_hc_burrlioz)
 export(ssd_hp)
 export(ssd_hp_bcanz)
 export(ssd_is_censored)
+export(ssd_licensing_md)
 export(ssd_match_moments)
 export(ssd_pal)
 export(ssd_pburrIII3)

diff --git a/R/licensing.R b/R/licensing.R
@@ -4,8 +4,8 @@
 #' and documentation
 #' @export
 #' @examples
-#' licensing_md()
-licensing_md <- function() {
+#' ssd_licensing_md()
+ssd_licensing_md <- function() {
 "## Licensing
   Copyright 2018-2024 Province of British Columbia\\
   Copyright 2021 Environment and Climate Change Canada\\

diff --git a/README.Rmd b/README.Rmd
@@ -144,5 +144,5 @@ If you would like to contribute to the package, please see our
 Please note that the ssdtools project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
 
 ```{r, results = "asis", echo = FALSE}
-cat(licensing_md())
+cat(ssd_licensing_md())
 ```
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -83,7 +83,7 @@ reference:
   - '`comma_signif`'
   - '`dist_data`'
   - '`is.fitdists`'
-  - '`licensing_md`'
+  - '`ssd_licensing_md`'
   - '`npars`'
   - '`ssd_data`'
   - '`ssd_ecd`'

diff --git a/man/licensing_md.Rd → man/ssd_licensing_md.Rd b/man/licensing_md.Rd → man/ssd_licensing_md.Rd
diff --git a/tests/testthat/test-licensing.R b/tests/testthat/test-licensing.R
@@ -1,3 +1,3 @@
 test_that("licensing works", {
-  expect_true(chk::vld_string(licensing_md()))
+  expect_true(chk::vld_string(ssd_licensing_md()))
 })
diff --git a/vignettes/additional-technical-details.Rmd b/vignettes/additional-technical-details.Rmd
@@ -128,5 +128,5 @@ We recognise the last expression as the *cdf* of a Weibull distribution with par
 
 
 ```{r, results = "asis", echo = FALSE}
-cat(ssdtools::licensing_md())
+cat(ssdtools::ssd_licensing_md())
 ```
diff --git a/vignettes/additional-technical-details.log b/vignettes/additional-technical-details.log
diff --git a/vignettes/articles/confidence-intervals.Rmd b/vignettes/articles/confidence-intervals.Rmd
@@ -176,5 +176,5 @@ p3
 <div id="refs"></div>
 
 ```{r, results = "asis", echo = FALSE}
-cat(licensing_md())
+cat(ssd_licensing_md())
 ```
diff --git a/vignettes/customising-plots.Rmd b/vignettes/customising-plots.Rmd
@@ -218,5 +218,5 @@ gp +
 <div id="refs"></div>
 
 ```{r, results = "asis", echo = FALSE}
-cat(licensing_md())
+cat(ssd_licensing_md())
 ```
diff --git a/vignettes/distributions.Rmd b/vignettes/distributions.Rmd
@@ -786,5 +786,5 @@ The inverse Weibull (log-Gumbel) distribution can be fitted in `ssdtools` by sup
 <div id="refs"></div>
 
 ```{r, results = "asis", echo = FALSE}
-cat(licensing_md())
+cat(ssd_licensing_md())
 ```
diff --git a/vignettes/faqs.Rmd b/vignettes/faqs.Rmd
@@ -61,6 +61,6 @@ ssd_plot(ccme_boron, boron_preds, xlab = "Concentration (mg/L)", ci = FALSE) +
 <div id="refs"></div>
 
 ```{r, results = "asis", echo = FALSE}
-cat(licensing_md())
+cat(ssd_licensing_md())
 ```
 
diff --git a/vignettes/model-averaging.Rmd b/vignettes/model-averaging.Rmd
@@ -460,7 +460,7 @@ Please see the [Getting started with ssdtools](https://poissonconsulting.github.
 <div id="refs"></div>
 
 ```{r, results = "asis", echo = FALSE}
-cat(licensing_md())
+cat(ssd_licensing_md())
 ```
 
 
diff --git a/vignettes/ssdtools.Rmd b/vignettes/ssdtools.Rmd
@@ -260,5 +260,5 @@ right_censored_dists <- try(ssd_fit_dists(right_censored_example,
 <div id="refs"></div>
 
 ```{r, results = "asis", echo = FALSE}
-cat(licensing_md())
+cat(ssd_licensing_md())
 ```