R/increment_counter.R

In rmflight/documentNumbering: Functions for Numbering in Documents

#' increment counter
#'
#' given a counter, add to it with a specific name
#'
#' @param counter the counter to add to
#' @param name the name for the value
#'
#' @export
#' @return named numeric
dn_increment_counter = function(counter, name){
  n_obj = length(counter)
  use_number = max(counter) + 1
  counter = c(counter, use_number)
  names(counter)[n_obj + 1] = name
  counter
}

#' paste counter
#'
#' Given a counter and a name to find, returns a string for insertion
#' into the text.
#'
#' @param counter the counter to search on
#' @param pre_string any text to paste first
#' @param identifier the id for the count
#'
#' @export
#' @return string
dn_paste_counter = function(counter, pre_string = "", identifier = NULL){
  if (is.null(identifier)) {
    stop("No identifier provided!")
  }
  if (!any(grepl(identifier, names(counter)))) {
    stop(paste0('identifier "', identifier, '" not found in the counter supplied!'))
  }
  id_number = counter[identifier]

  if (length(id_number) > 1) {
    str_numbers = paste(id_number, collapse = ", ")
  } else {
    str_numbers = id_number
  }

  use_text = paste(pre_string, str_numbers, sep = "")

  use_text
}


#' figure string
#'
#' Generate a figure string with the number included.
#'
#' @param counter the counter object
#' @param identifier the identifier to get the number for
#' @param supplemental should an "S" be added to the label first?
#'
#' @export
#' @return character
dn_figure_string = function(counter, identifier = NULL, supplemental = FALSE){
  if (supplemental) {
    fig_str = "Figure S"
  } else {
    fig_str = "Figure "
  }
  dn_paste_counter(counter, fig_str, identifier)
}

#' table string
#'
#' Generate a "Table " string with the number included.
#'
#' @param counter the counter object
#' @param identifier the identifier to get the number for
#' @param supplemental should an "S" be added to the identifier
#'
#' @export
#' @return character
dn_table_string = function(counter, identifier = NULL, supplemental = FALSE){
  if (supplemental) {
    table_str = "Table S"
  } else {
    table_str = "Table"
  }
  dn_paste_counter(counter, table_str, identifier)
}


#' figure rename
#'
#' Generate a figure number for renaming within a path.
#'
#' @param counter the counter object
#' @param identifier the identifier for the figure
#' @param supplemental is this a supplemental
#'
#' @export
#' @return character
dn_figure_rename = function(counter, identifier = NULL, supplemental = FALSE){
  if (supplemental) {
    fig_str = "figure_s"
  } else {
    fig_str = "figure_"
  }
  dn_paste_counter(counter, fig_str, identifier)
}