R/note_chunk.R

In LudvigOlsen/LRO.utilities: Utility functions and addins

#' @title Insert note chunk.
#' @description Addin for RStudio for inserting code chunks named "note" and with include=FALSE in R Markdown.
#'
#' See \code{details} for setting up key command.
#' @author Ludvig Renbo Olsen, \email{r-pkgs@ludvigolsen.dk}
#' @export
#' @return Inserts \code{```{note, include=FALSE, eval=FALSE}\n\"\n\n\"\n```}
#' @details How to set up key command in RStudio:
#'
#' After installing package.
#' Go to:
#'
#' \code{Tools} >> \code{Addins} >> \code{Browse Addins} >> \code{Keyboard Shortcuts}.
#'
#' Find \code{"Insert Note Chunk"} and press its field under \code{Shortcut}.
#'
#' Press desired key command.
#'
#' Press \code{Apply}.
#'
#' Press \code{Execute}.
insertNoteChunk <- function() {

  # Insert text that splits the code chunk in two
  rstudioapi::insertText("```{note, include=FALSE, eval=FALSE}\n\"\n\n\"\n```")

  # Get document context
  # to get cursor position
  adc <- rstudioapi::getActiveDocumentContext()

  # Get cursor position
  start <- adc$selection[1][[1]]$range$start

  # Set cursor in-between chunks
  rstudioapi::setCursorPosition(c(start['row'] -2, 1), id = NULL)


}