R/pretty_print.R

In emjun/tisaner: Authoring Statistical Models from Conceptual Models

#' Prints a relationship
#'
#' Returns string describing what type of relationship the @param obj is
#' @param obj Relates or Causes object
# pretty_print()
setGeneric("pretty_print", function(obj) standardGeneric("pretty_print"))
setMethod("pretty_print", signature("Relates"), function(obj)
{
    if (!is(obj, "Relates")) stop("Object is not of class 'Relates'")
    lhs <- obj@lhs
    rhs <- obj@rhs
    str <- paste(lhs@name, "and", rhs@name, "are related", sep=" ")

    # Return str
    str
})
#' Prints a relationship
#'
#' Returns string describing what type of relationship the @param obj is
#' @param obj Relates or Causes object
# pretty_print()
setMethod("pretty_print", signature("Causes"), function(obj)
{
    if (!is(obj, "Causes")) stop("Object is not of class 'Causes'")
    cause <- obj@cause
    effect <- obj@effect
    str <- paste(cause@name, "causes", effect@name, sep=" ")

    # Return str
    str
})
# setMethod("pretty_print", signature("Assumption"), function(obj)
# {
#     rel <- obj@relationship
#     rel_str <- pretty_print(rel)
#     str <- paste("Assume", rel_str, sep=" ")

#     # Return str
#     str
# })
# setMethod("pretty_print", signature("Hypothesis"), function(obj)
# {
#     rel <- obj@relationship
#     rel_str <- pretty_print(rel)
#     str <- paste("Hypothesize", rel_str, sep=" ")
    
#     # Return str
#     str
# })