♻️ Rename function to compute epanechnikov

NAMESPACE

@@ -15,7 +15,7 @@ S3method(split_linestring,sfc_LINESTRING)
 S3method(summary,road_network)
 S3method(summary,segmented_network)
 export(assign_event_to_link)
-export(calculate_weights_epanechnikov)
+export(compute_epanechnikov)
 export(create_bbox)
 export(create_coordinates)
 export(create_graph)

R/calculate-weights-epanechnikov.R → R/compute-epanechnikov.R

@@ -1,18 +1,16 @@
-#' Epanechnikov kernel
+#' Compute the Epanechnikov function
 #'
-#' The kernel is one of the quadratic kernels used
-#' in kernel density estimation.
-#'
-#' Epanechnikov kernel is defined as follows:
+#' The Epanechnikov function is one of the quadratic kernels used in
+#' kernel density estimation. It is defined as follows:
 #' \deqn{K(x) = \frac{3}{4}(1 - x^2) \quad \text{if} \quad |x| \leq 1\text{.}}
 #'
 #' @param x A numeric vector.
 #' @return A numeric vector of weights of the kernel for each input points.
 #' @export
 #' @examples
 #' x <- seq(-3, 3, 0.1)
-#' y <- calculate_weights_epanechnikov(x)
-#' plot(x, y, type = "l")
-calculate_weights_epanechnikov <- function(x) {
+#' y <- compute_epanechnikov(x)
+#' plot(x, y, xlim = c(-3, 3), ylim = c(0, 1), type = "l")
+compute_epanechnikov <- function(x) {
   return(ifelse(abs(x) <= 1, (3 / 4) * (1 - x^2), 0))
 }

pkgdown/_pkgdown.yml

@@ -2,6 +2,7 @@ url: https://nononoexe.github.io/pavement/
 
 template:
   bootstrap: 5
+  math-rendering: katex
   light-switch: true
   theme: gruvbox-light
   theme-dark: gruvbox-dark