aboutsummaryrefslogtreecommitdiff
path: root/man/status.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'man/status.Rd')
-rw-r--r--man/status.Rd44
1 files changed, 44 insertions, 0 deletions
diff --git a/man/status.Rd b/man/status.Rd
new file mode 100644
index 00000000..1cadbfcc
--- /dev/null
+++ b/man/status.Rd
@@ -0,0 +1,44 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/status.R
+\name{status}
+\alias{status}
+\alias{status.mmkin}
+\alias{print.status.mmkin}
+\alias{status.mhmkin}
+\alias{print.status.mhmkin}
+\title{Method to get status information for fit array objects}
+\usage{
+status(object, ...)
+
+\method{status}{mmkin}(object, ...)
+
+\method{print}{status.mmkin}(x, ...)
+
+\method{status}{mhmkin}(object, ...)
+
+\method{print}{status.mhmkin}(x, ...)
+}
+\arguments{
+\item{object}{The object to investigate}
+
+\item{\dots}{For potential future extensions}
+
+\item{x}{The object to be printed}
+}
+\value{
+An object with the same dimensions as the fit array
+suitable printing method.
+}
+\description{
+Method to get status information for fit array objects
+}
+\examples{
+\dontrun{
+fits <- mmkin(
+ c("SFO", "FOMC"),
+ list("FOCUS A" = FOCUS_2006_A,
+ "FOCUS B" = FOCUS_2006_C),
+ quiet = TRUE)
+status(fits)
+}
+}

Contact - Imprint