Warn about regex_gadget() deprecation

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(regex_gadget)
 export(regexplain_cheatsheet)
 export(regexplain_file)
 export(regexplain_gadget)

NEWS.md

@@ -5,6 +5,9 @@
 * Rewrote regexp-matching internals, the RStudio addin can now display global
   regexp matches.
   
+* All app-related functions are now prefixed with `regexplain_`. In particular,
+  `regex_gadget()` was renamed in favor of `regexplain_gadget()`.
+  
 * `regexplain_gadget()` accepts both `text` and `pattern` arguments, so you can
   easily load text or regular expressions from your R session into the gadget.
   If you're working with designing a regular expression, this lets you move

R/regexplain-deprecated.R

@@ -0,0 +1,19 @@
+#' Deprecated or renamed functions
+#'
+#' These functions in regexplain have been deprecated or renamed.
+#'
+#' @param ... Arguments passed to the new or renamed functions.
+#' @return The result of the new or renamed function.
+#' @name regexplain-deprecated
+NULL
+
+#' @description
+#' Use [regexplain_gadget()] instead of `regex_gadget()`.
+#'
+#' @export
+#' @keywords internal
+#' @rdname regexplain-deprecated
+regex_gadget <- function(...) {
+  .Deprecated(msg = "regex_gadget() was renamed. Please use `regexplain_gadget()` instead.")
+  regexplain_gadget(...)
+}