📝 Move interactive vignette to inst

ThierryO · ThierryO · commit 8984cee9046c · 2025-03-12T14:34:13.000+01:00
The build vignette is too large.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -13,6 +13,7 @@
 ^codecov\.yml$
 ^data-raw$
 ^docs$
+^inst/*\.html$
 ^man-roxygen$
 ^organisation.yml$
 ^pkgdown$
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -27,8 +27,6 @@ navbar:
         href: articles/classification.html
       - text: Visualising Effects with `ggplot2`
         href: articles/visualisation.html
-      - text: Visualising Effects with `plotly`
-        href: articles/interactive.html
 reference:
 - title: Classification of Effects
   contents:
diff --git a/inst/interactive.Rmd b/inst/interactive.Rmd
@@ -11,7 +11,7 @@ vignette: >
 
 ```{r setup, include = FALSE}
 library(knitr)
-opts_chunk$set(collapse = TRUE, comment = "#>")
+opts_chunk$set(collapse = TRUE, comment = "#>", fig.width = 7, fig.height = 6)
 inbo_colours <- c("#282A72", "#EF972C")
 ```
 
@@ -144,6 +144,31 @@ plot_ly(timeserie, x = ~year, y = ~index) |>
   add_vert_norm(sd = ~s, link = "log")
 ```
 
+## `add_classifiction()`
+
+```{r add-classification}
+z <- data.frame(
+  estimate = c(-0.5, 0, 0.5, 1.5, 1, 0.5, 0, -0.5, -1, -1.5),
+ sd = c(rep(0.8, 3), rep(0.3, 7))
+)
+z$lcl <- qnorm(0.05, z$estimate, z$sd)
+z$ucl <- qnorm(0.95, z$estimate, z$sd)
+classification(z$lcl, z$ucl, threshold = 1) -> z$effect
+z$x <- class_labels(type = "effect")[z$effect]
+z$x <- factor(z$x, z$x)
+z$display <- paste(
+ "estimate:", format_ci(z$estimate, lcl = z$lcl, ucl = z$ucl)
+)
+plot_ly(z, x = ~x, y = ~estimate) |>
+ add_fan(sd = ~sd, text = ~display) |>
+ add_classification(lcl = ~lcl, ucl = ~ucl, threshold = 1) |>
+ layout(
+   hovermode = "x unified",
+   shapes = reference_shape(threshold = 1),
+   annotations = reference_text(threshold = 1)
+ )
+```
+
 ## Reference
 
 The `reference_shape()` and `reference_text()` functions can be used to add a reference lines and text to the plot.
diff --git a/inst/references.bib b/inst/references.bib
diff --git a/vignettes/visualisation.Rmd b/vignettes/visualisation.Rmd
@@ -1,7 +1,7 @@
 ---
 title: "Visualising Effects with `ggplot2`"
 author: Thierry Onkelinx
-bibliography: references.bib
+bibliography: '`r system.file("references.bib", package = "effectclass")`'
 output: rmarkdown::html_vignette
 vignette: >
   %\VignetteIndexEntry{Visualising Effects with `ggplot2`}
@@ -137,6 +137,9 @@ The `vignette("classification", package = "effectclass")` explains how we can cl
 This vignette focusses on visualising effect and their uncertainty.
 The packages provides two `ggplot()` layers (`stat_fan()` and `stat_effect()`) and a scale (`scale_effect()`).
 
+Note that this package also supports `plotly`.
+Run `rmarkdown::render(system.file("interactive.Rmd", package = "effectclass"))` to generate this document.
+
 ## `stat_fan()`
 
 The Bank of England visualises uncertainty by using a fan plot [@britton.fisher.ea1998InflationReportProjections].
