R/sink_reset.R

In philipmorrisintl/GladiaTOX: R Package for Processing High Content Screening data

#####################################################################
## This program is distributed in the hope that it will be useful, ##
## but WITHOUT ANY WARRANTY; without even the implied warranty of  ##
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the    ##
## GNU General Public License for more details.                    ##
#####################################################################

#-------------------------------------------------------------------------------
# sink_reset: Reset all sink connections, returning all output to console
#-------------------------------------------------------------------------------

#' @title Reset all sinks
#'
#' @description
#' \code{sink_reset} resets all sinks and returns all output to the console.
#'
#' @details
#' \code{sink_reset} identifies all sinks with \code{sink.number} then returns
#' all output and messages back to the console.
#' 
#' @return None
#' 
#' @keywords internal
#'
#' @family gtox abbreviations
#' @seealso \code{\link{sink}}, \code{\link{sink.number}}

sink_reset <- function() {

    for (i in seq_len(sink.number())) {
        sink(NULL)
        sink(NULL, type="message")
    }
}

#-------------------------------------------------------------------------------