add mathExpression

DESCRIPTION

@@ -34,7 +34,7 @@ Imports:
   svglite,
   systemfonts,
   withr
-RoxygenNote: 7.2.2
+RoxygenNote: 7.2.3
 Roxygen: list(markdown = TRUE)
 Encoding: UTF-8
 LinkingTo: Rcpp

NAMESPACE

@@ -103,6 +103,7 @@ export(jaspResultsCalledFromJasp)
 export(logNormDist)
 export(logit)
 export(makeJaspFormula)
+export(mathExpression)
 export(negBinomDist)
 export(normalDist)
 export(poisDist)

R/mathExpression.R

@@ -0,0 +1,28 @@
+#' LaTeX Expressions in JASP
+#'
+#' @description Construct LaTeX expressions for JASP output
+#'
+#' @param x A string that contains the LaTeX code for the math expression
+#' @param inline Should the expression be inline or in display mode?
+#'
+#' @examples
+#' # Escape the backslash character for LaTeX code
+#' jaspBase::mathExpression("\\alpha + \\beta")
+#' # Alternatively use the raw character constant
+#' jaspBase::mathExpression(r"{\alpha + \beta}")
+#'
+#' # By default expressions are inline, to disable use
+#' jaspBase::mathExpression(r"{ \bar{x} = \frac{\sum_i^n x_i}{n} }", inline = FALSE)
+#'
+#' @export
+mathExpression <- function(x, inline = TRUE) {
+  stopifnot(is.character(x))
+
+  if (!inline) {
+    output <- sprintf("\\[%s\\]", x)
+  } else {
+    output <- sprintf("\\(%s\\)", x)
+  }
+
+  return(output)
+}