R/naming.R

In path.chain: Concise Structure for Chainable Paths

#' @name naming_k
#' @title Naming convention, which adds k prefix for each key, capitalizes and removes file extension
#' @param path full path or its element
#' @importFrom tools file_path_sans_ext
#' @importFrom stringi stri_trans_totitle
#' @examples
#' library(magrittr)
#' naming_k("path/to/myfile.txt")
#' # Using with full_path_chain
#' tmp <- create_temp_dir("files")
#' create_sample_dir(tmp, override = TRUE)
#' full.path.chain <- full_path_chain(tmp, naming = naming_k)
#' full.path.chain
#' tmp <- create_temp_dir("files")
#' create_sample_dir(tmp)
#' # Using with path_chain / create_path_chain
#' path.chain <- path_chain(tmp, naming = naming_k)
#' path.chain %>%
#'   as.list()
#' @export
naming_k <- function(path){
  paste0("k", tools::file_path_sans_ext(stringi::stri_trans_totitle(basename(path))))
}