R/truncMessage.R

In berryFunctions: Function Collection Related to Plotting and Hydrology

#' truncate message parts
#' 
#' truncate long vectors for messages
#' 
#' @return Character string
#' @author Berry Boessenkool, \email{berry-b@@gmx.de}, Nov 2016
#' @seealso \code{\link{message}}
#' @keywords character
# @importFrom package fun1 fun2
#' @export
#' @examples
#' truncMessage("hi")
#' message("listing name", truncMessage(       "hi"      ), ".")
#' message("listing name", truncMessage(paste0("hi",1:10)), ".")
#' truncMessage(paste0("hi",1:10), ntrunc=1)
#' truncMessage(paste0("hi",1:10), ntrunc=2, prefix="", midfix="")
#' truncMessage(paste0("hi",1:10), ntrunc=8, prefix="files _ ")
#' 
#' @param x Character vector
#' @param ntrunc Integer: number of elements printed before truncation. DEFAULT: 3
#' @param prefix Character: Prefix added if \code{length(x)>1}. DEFAULT: "s"
#' @param midfix Character: string added after prefix OR before first altnix. DEFAULT: " "
#' @param altnix Character: Alternative string padded around x if \code{length(x)==1}.
#'               DEFAULT: "'"
#' @param sep    Character: Separator between elements. DEFAULT: ", "
#' 
truncMessage <- function(
x,
ntrunc=3,
prefix="s",
midfix=" ",
altnix="'",
sep=", "
)
{
l <- length(x)
if(l>ntrunc) x <- x[1:ntrunc]
paste0(if(l>1) paste0(prefix,midfix) else paste0(midfix,altnix), paste0(x, collapse=sep),
       if(l>ntrunc) paste(if(!missing(sep)) sep, " (and",l-ntrunc,"more)"), if(l==1) altnix)
}