R/console.r

In RLogik/rbettersyntax: Simpler Syntax for R

#' @title console.log
#' @description Allow for simpler syntax in R. Output messages to console. Use \code{options('utilsRL::silent'=TRUE)} to disable console output.
#' @export console.log
#'
#' @usage \code{console.log(tabs=tabs, tab.char=tab.char, silent.off=silent.off, m1, m2, ..)}
#' @param tabs a non-negative integer. Default \code{0}. Number of tab sets to be produced on each new line.
#' @param tab.char character. Default \code{'  '}. This will be used as the indentation string.
#' @param silent.off boolean. Default \code{FALSE}. If true, then no output will be shown under the option \code{'utilsRL::silent'=TRUE}.
#' @param m1 character string / vector of character strings. The strings will be concatenated with no spaces, prepended by tab stops and followed by a \code{'\n'} character.
#' @param m2 similar. User can set 0 or more 'messages' to be printed in the console.
#'
#' @examples \dontrun{
#'	console.log(tabs=0, 'Test');
#'	console.log(tabs=1, silent.off=TRUE, 'Starting Method', c('Scanning data set ',k,' for solutions:'));
#' }
#'
#' @keywords syntax console.log console log

console.log <- function(tabs=0, tab.char='  ', silent.off=TRUE, ...) {
	lines <- list(...);
	rsilent <-  FALSE;
	if(silent.off) {
		rsilent <- getOption('utilsRL::silent');
		if(!is.logical(rsilent)) rsilent <- FALSE;
	}
	if(!rsilent) {
		indent <- rep(tab.char, tabs);
		for(s in lines) base::message(paste0(indent,s));
	}
};




#' @title console.clear
#' @description Allow for simpler syntax in R. Clear console.
#' @export console.clear
#'
#' @usage \code{console.clear()}
#'
#' @examples \dontrun{
#'	console.clear();
#' }
#'
#' @keywords syntax console.clear

console.clear <- function() {
	if(.Platform$OS.type == 'unix') { ## MAC OSX / Linux
		base::system('clear');
	} else { ## Windows
		base::shell('cls');
	}
};