From b703ee38ffc8877be843cf5a557dd9c32c54f977 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
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/illparms.Rd | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 man/illparms.Rd

(limited to 'man/illparms.Rd')

diff --git a/man/illparms.Rd b/man/illparms.Rd
new file mode 100644
index 00000000..7f70229d
--- /dev/null
+++ b/man/illparms.Rd
@@ -0,0 +1,46 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/illparms.R
+\name{illparms}
+\alias{illparms}
+\alias{illparms.mkinfit}
+\alias{illparms.mmkin}
+\alias{print.illparms.mmkin}
+\title{Method to get the names of ill-defined parameters}
+\usage{
+illparms(object, ...)
+
+\method{illparms}{mkinfit}(object, conf.level = 0.95, ...)
+
+\method{illparms}{mmkin}(object, conf.level = 0.95, ...)
+
+\method{print}{illparms.mmkin}(x, ...)
+}
+\arguments{
+\item{object}{The object to investigate}
+
+\item{\dots}{For potential future extensions}
+
+\item{conf.level}{The confidence level for checking p values}
+
+\item{x}{The object to be printed}
+}
+\value{
+For \link{mkinfit} objects, a character vector of parameter names
+For \link{mmkin} objects, an object of class 'illparms.mmkin' with a
+suitable printing method.
+}
+\description{
+Method to get the names of ill-defined parameters
+}
+\examples{
+fit <- mkinfit("FOMC", FOCUS_2006_A, quiet = TRUE)
+illparms(fit)
+\dontrun{
+fits <- mmkin(
+  c("SFO", "FOMC"),
+  list("FOCUS A" = FOCUS_2006_A,
+       "FOCUS C" = FOCUS_2006_C),
+  quiet = TRUE)
+illparms(fits)
+}
+}
-- 
cgit v1.2.1