From 0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Fri, 25 Oct 2019 00:37:42 +0200
Subject: Use roxygen for functions and methods

---
 man/plot.mmkin.Rd | 96 +++++++++++++++++++++++++++----------------------------
 1 file changed, 48 insertions(+), 48 deletions(-)

(limited to 'man/plot.mmkin.Rd')

diff --git a/man/plot.mmkin.Rd b/man/plot.mmkin.Rd
index 90b92d27..333998da 100644
--- a/man/plot.mmkin.Rd
+++ b/man/plot.mmkin.Rd
@@ -1,62 +1,58 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plot.mmkin.R
 \name{plot.mmkin}
 \alias{plot.mmkin}
-\title{
-  Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object
-}
-\description{
-  When x is a row selected from an mmkin object (\code{\link{[.mmkin}}), the same model
-  fitted for at least one dataset is shown. When it is a column, the fit of at least one model
-  to the same dataset is shown.
-
-  If the current plot device is a \code{\link[tikzDevice]{tikz}} device,
-  then latex is being used for the formatting of the chi2 error level.
-}
+\title{Plot model fits (observed and fitted) and the residuals for a row or column
+of an mmkin object}
 \usage{
 \method{plot}{mmkin}(x, main = "auto", legends = 1,
-  resplot = c("time", "errmod"), show_errmin = TRUE, errmin_var = "All data", 
-  errmin_digits = 3, cex = 0.7, rel.height.middle = 0.9, ...)
+  resplot = c("time", "errmod"), show_errmin = TRUE,
+  errmin_var = "All data", errmin_digits = 3, cex = 0.7,
+  rel.height.middle = 0.9, ...)
 }
 \arguments{
-  \item{x}{
-    An object of class \code{\link{mmkin}}, with either one row or one column.
-}
-  \item{main}{
-    The main title placed on the outer margin of the plot.
-}
-  \item{legends}{
-    An index for the fits for which legends should be shown.
-}
-  \item{resplot}{
-    Should the residuals plotted against time, using \code{\link{mkinresplot}},
-    or as squared residuals against predicted values, with the error model,
-    using \code{\link{mkinerrplot}}.
-}
-  \item{show_errmin}{
-    Should the chi2 error level be shown on top of the plots to the left?
-  }
-  \item{errmin_var}{
-    The variable for which the FOCUS chi2 error value should be shown.
-}
-  \item{errmin_digits}{
-    The number of significant digits for rounding the FOCUS chi2 error percentage.
-}
-  \item{cex}{
-    Passed to the plot functions and \code{\link{mtext}}.
-}
-  \item{rel.height.middle}{
-    The relative height of the middle plot, if more than two rows of plots are shown.
-}
-  \item{\dots}{
-    Further arguments passed to \code{\link{plot.mkinfit}} and \code{\link{mkinresplot}}.
-}
+\item{x}{An object of class \code{\link{mmkin}}, with either one row or one
+column.}
+
+\item{main}{The main title placed on the outer margin of the plot.}
+
+\item{legends}{An index for the fits for which legends should be shown.}
+
+\item{resplot}{Should the residuals plotted against time, using
+\code{\link{mkinresplot}}, or as squared residuals against predicted
+values, with the error model, using \code{\link{mkinerrplot}}.}
+
+\item{show_errmin}{Should the chi2 error level be shown on top of the plots
+to the left?}
+
+\item{errmin_var}{The variable for which the FOCUS chi2 error value should
+be shown.}
+
+\item{errmin_digits}{The number of significant digits for rounding the FOCUS
+chi2 error percentage.}
+
+\item{cex}{Passed to the plot functions and \code{\link{mtext}}.}
+
+\item{rel.height.middle}{The relative height of the middle plot, if more
+than two rows of plots are shown.}
+
+\item{\dots}{Further arguments passed to \code{\link{plot.mkinfit}} and
+\code{\link{mkinresplot}}.}
 }
 \value{
-  The function is called for its side effect.
+The function is called for its side effect.
 }
-\author{
-  Johannes Ranke
+\description{
+When x is a row selected from an mmkin object (\code{\link{[.mmkin}}), the
+same model fitted for at least one dataset is shown. When it is a column,
+the fit of at least one model to the same dataset is shown.
+}
+\details{
+If the current plot device is a \code{\link[tikzDevice]{tikz}} device, then
+latex is being used for the formatting of the chi2 error level.
 }
 \examples{
+
   \dontrun{
   # Only use one core not to offend CRAN checks
   fits <- mmkin(c("FOMC", "HS"),
@@ -73,4 +69,8 @@
   # Show the error models
   plot(fits["FOMC", ], resplot = "errmod")
   }
+
+}
+\author{
+Johannes Ranke
 }
-- 
cgit v1.2.1