R/wpProgressMessage.R

In wpgp/wpUtilities: Data Analysis and Modeling Package from WorldPop

# Authors: Maksym Bondarenko mb4@soton.ac.uk
# Date :  October 2017
# Version 0.1
#
#' wpProgressMessage function will return progress
#'
#' Tested on Windows 10
#' @param x integer
#' @param max maximum for progress bvar
#' @param label additional text for progress  bar
#' @rdname wpProgressMessage
#' @return character
#' @export
#' @examples
#' wpProgressMessage( x=10, max = 200, label="Progress message" )
wpProgressMessage <- function (x, max = 100, label=NULL) {

  if (is.null(label)) label=''
  if (x != max) ar = '>' else ar=''

  percent <- x / max * 100
  cat(sprintf('\r[%-50s] %d%% %s',
              paste(paste(rep('=', percent / 2), collapse = ''),'',sep = ar),
              floor(percent),
              label))
  if (x == max)
    cat('\n')
}