R/dist-fDISTFIT.R

In fBasics: Rmetrics - Markets and Basic Statistics

# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Library General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library 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 Library General Public License for more details.
#
# You should have received a copy of the GNU Library General
# Public License along with this library; if not, write to the
# Free Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA  02111-1307  USA


################################################################################
# FUNCTION:            DESCRIPTION:
#  'fDISTFIT'           S4 Class representation
#  show.fDISTFIT        Prints Results from a Fitted Distribution
################################################################################


setClass("fDISTFIT",
    representation(
        call = "call",
        model = "character",
        data = "data.frame",
        fit = "list",
        title = "character",
        description = "character"
    )
)


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

setMethod("show", "fDISTFIT",
    function(object) {
        ## A function implemented by Diethelm Wuertz
        ##
        ## Description:
        ##   Prints Results from a Fitted Distribution
        
        ## FUNCTION:
        
        ## Title:
        cat("\nTitle:\n ")
        cat(object@title, "\n")
        
        ## Call:
        cat("\nCall:\n ")
        cat(paste(deparse(object@call), sep = "\n", collapse = "\n"),
            "\n", sep = "")
        
        ## Model:
        cat("\nModel:\n ", object@model, "\n", sep = "")
        
        ## Estimate:
        cat("\nEstimated Parameter(s):\n")
        print(object@fit$estimate)
        
        ## Description:
        ## GNB: don't print description if it is ""
        if(!identical(object@description, "")) { 
            cat("\nDescription:\n ")
            cat(object@description, "\n")
        }
        
        cat("\n")
      
        ## Return Value:
        invisible()
    })


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





################################################################################