R/txx_identify_sections.R

In michael-ccccc/textured: Tools for Structuring Semi-structured Text Data

#' Identify sections within text, and wrap in tags
#'
#' This function identifies the tags within a character string, and then wraps
#' the identified text in XML tag syntax. Generally not used outside of the
#' \code{\link{txx_text_to_xml}} function, but has its uses.
#' 
#' Note that tag order is important - the first tags are identified first and
#' modify the string. If there is another tag that would have identified a
#' section within that string before the first tag, it would not identify it
#' after.
#' 
#' Tags can be regular expressions - use with caution to avoid mis-identifying
#' sections.
#'
#'
#' @param string A character string of the document to be searched
#' @param tags A vector of character strings - strings used to identify a 
#' section of text
#' @param ignore_case Logic value of whether you want to ignore the case when
#' identifying the sections
#'
#' @return A character string with sections identified and wrapped in an XML tag.
#' 
#'
## TODO: do I need to put an example here?

txx_identify_sections <- function(string, 
                                  tags, 
                                  # remove = NA_character_, 
                                  ignore_case = TRUE){

  # TODO: figure out remove - do we even still use it?
  # TODO: txx_wrap_tag has some additional arguments we can use - need to
  # figure out how to show these in this function, and maybe ultimately the
  # final function.
  
  for(i in tags){
    
    string <- stringr::str_replace_all(string, pattern = stringr::regex(i, ignore_case = ignore_case), replacement = txx_wrap_tag)
    
  }
  
  string
  
}