R/chunknamer.R

In ThinkR-open/remedy: 'RStudio' Addins to Simplify 'Markdown' Writing

#' @title Interactively Add Names to Chunks
#' @description Addin that add in bulk a names to unnamed chunks in a 
#' Rmarkdown document in the source editor.
#' @return NULL
#' @details
#'
#' By default the addin will use "remedy" as the stem of the chunk names. this an be changed using
#' \code{\link{remedy_opts}}$set(name='ANOTHER NAME'). The names are then added in sequential order using
#' an %02d naming scheme.
#'
#' @rdname chunknamer
#' @export
chunknamer <- function(){

  adc <- rstudioapi::getSourceEditorContext()

  this <- adc$contents
  
  x <- grep('^```\\{(.*?)r',this)
  
  current_names <- gsub('```\\{(.*?)r|\\}|\\s+','',sapply(strsplit(this[x],','),'[',1))
  
  #remove chunk options that are in first position
  no_name_opts <- which(grepl('=',current_names))
  
  current_names[no_name_opts] <- ""
  
  no_name <- which(!nzchar(current_names))
  
  counter_size <- pmax(nchar(as.character(length(no_name))) - 1,2)
  
  counter <- paste0('%0',counter_size,'d')
  
  for(i in seq_along(no_name)){
    
    bump <- 0
    
    new_name <- sprintf(paste0('%s',counter),remedy_opts$get('name'),(i + bump))
    
    # in case new name already exists bump counter until unused name is found
      while(new_name%in%current_names){
        bump <- bump + 1
        new_name <- sprintf(paste0('%s',counter),remedy_opts$get('name'),(i + bump))
      }
    
    comma <- ifelse(no_name[i]%in%no_name_opts,',','')
    
    this[x][no_name[i]] <- gsub('^```\\{(.*?)r',
                                sprintf('```{r %s%s',new_name,comma),
                                this[x][no_name[i]]
    )
    
    idx <- x[no_name][i]
    
    rng <- Map(c, Map(c, idx, 1), Map(c, idx, Inf))
    
    rstudioapi::modifyRange(rng,this[x][no_name[i]],id = adc$id)
  }
  
}