R/dmsg.R

In ropensci/datapack: A Flexible Container to Transport and Manipulate Data and Associated Resources

#
#   This work was created by participants in the DataONE project, and is
#   jointly copyrighted by participating institutions in DataONE. For
#   more information on DataONE, see our web site at http://dataone.org.
#
#     Copyright 2011-2014
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#

#' Print a debugging message to stderr.
#' @details Only print the message if the option "datapack.debugging_mode" is TRUE.
#' @param msg the message to be printed
dmsg <- function(msg) {
    dbg <- getOption("datapack.debugging_mode", default = FALSE)
    if (dbg) {
        message(msg)
    }
}