R/module_set_VersionNumber.R

In R-Lum/RLumBuild: RLum Universe Package Building

#' Module: set_VersionNumber
#'
#' @description Automatically set version number in DESCRIPTION file if the pattern '.9000' is found.
#'
#' @details If the package is under development it is somehow meaningful to easily distinguish
#' between different build versions. In the R community the pattern `.9000` in a version number is
#' used to declare a package under development. If such pattern is found, the module
#' either adds `-1` or if already their, increase such number by `1` every time the package
#' is built.
#'
#' For release versions the patter `.9000` is removed from the DESCRIPTION file and nothing
#' is done if the module is run.
#'
#' @author Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany)
#'
#' @section Function version: 0.1.0
#'
#'
#' @export
module_set_VersionNumber<- function() {

  # Set new date and version number -----------------------------------------------------------------
  ##read DESCRIPTION
  temp <- readLines("DESCRIPTION")

  ##grep date and version number
  version_date <- grep(pattern = "Date:", x = temp, fixed = TRUE)
  version_id <- grep(pattern = "Version:", x = temp, fixed = TRUE)

  ##update date
  temp[version_date] <- paste0("Date: ", Sys.Date())

  ##update version number only if it does not contain .9000
  ##(the unwritten R package convention proposed by H.W.)
  if(grepl(x = temp[version_id], pattern = ".9000", fixed = TRUE)){
    version_number <-
      unlist(strsplit(x = temp[version_id], split = ".9000-", fixed = TRUE))

    if(length(version_number) == 1){
      version_number <- paste0(version_number, "-1")

    }else{
      version_number <- paste0(version_number[1],".9000-",as.numeric(version_number[2]) + 1)

    }

    temp[version_id] <- version_number

  }

  ##write back to file
  writeLines(text = temp, con = "DESCRIPTION")

  invisible(paste(version_date, " | ", version_id))

}