R/rmd_equations.R

In GegznaV/addins.rmd: RStudio Add-ins to Format R Markdown Documents

# TODO: rewrite the functions for Visual Markdown Editor mode.

# Equations -------------------------------------------------------------------
#' Format as LaTeX equation.
#'
#' Select a piece of text with a cursor and call these functions as an add-in
#' to enclose the text with special symbols. Text between `$.$` is
#' interpreted as an inline equation and between `$$.$$` or `\[.\]`
#' as a block equation in R Markdown.
#'
#' @name rmd_equations
#'
#' @inheritParams addin.tools::rs_get_index
#'
#' @family R Markdown formatting add-ins
NULL

# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @rdname rmd_equations
#' @export
rmd_equation_a_inline <- function(context = rs_get_context()) {
  rs_enclose_selection_with(
    symbol = "$",
    context = context
  )
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @rdname rmd_equations
#' @export
rmd_equation_b_block <- function(context = rs_get_context()) {
  rs_enclose_selection_with(
    symbol = "$$",
    context = context
  )
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @rdname rmd_equations
#' @export
rmd_equation_b_block2 <- function(context = rs_get_context()) {
  rs_enclose_selection_with(
    symbol_before = "\\[", symbol_after = "\\]",
    context = context
  )
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~