From b703ee38ffc8877be843cf5a557dd9c32c54f977 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 21 Jul 2022 17:15:12 +0200 Subject: Summary method for mmkin objects Also, add a method for gathering convergence information and a method for gathering information on ill-defined parameters --- man/summary.mmkin.Rd | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 man/summary.mmkin.Rd (limited to 'man/summary.mmkin.Rd') diff --git a/man/summary.mmkin.Rd b/man/summary.mmkin.Rd new file mode 100644 index 00000000..69245621 --- /dev/null +++ b/man/summary.mmkin.Rd @@ -0,0 +1,36 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/summary.mmkin.R +\name{summary.mmkin} +\alias{summary.mmkin} +\alias{print.summary.mmkin} +\title{Summary method for class "mmkin"} +\usage{ +\method{summary}{mmkin}(object, conf.level = 0.95, ...) + +\method{print}{summary.mmkin}(x, digits = max(3, getOption("digits") - 3), ...) +} +\arguments{ +\item{object}{an object of class \link{mmkin}} + +\item{conf.level}{confidence level for testing parameters} + +\item{\dots}{optional arguments passed to methods like \code{print}.} + +\item{x}{an object of class \code{summary.mmkin}.} + +\item{digits}{number of digits to use for printing} +} +\description{ +Shows convergence information on the \link{mkinfit} objects contained in the object +and gives an overview of ill-defined parameters calculated by \link{illparms}. +} +\examples{ + +fits <- mmkin( + c("SFO", "FOMC"), + list("FOCUS A" = FOCUS_2006_A, + "FOCUS C" = FOCUS_2006_C), + quiet = TRUE, cores = 1) + summary(fits) + +} -- cgit v1.2.1