From af2e1540cdad2fd00bb6216a38a754ff748629ad Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 25 Oct 2019 02:10:08 +0200 Subject: Static documentation rebuilt by pkgdown --- docs/reference/plot.mmkin.html | 76 ++++++++++++++++++++++++------------------ 1 file changed, 43 insertions(+), 33 deletions(-) (limited to 'docs/reference/plot.mmkin.html') diff --git a/docs/reference/plot.mmkin.html b/docs/reference/plot.mmkin.html index 9a11108f..8b68cfae 100644 --- a/docs/reference/plot.mmkin.html +++ b/docs/reference/plot.mmkin.html @@ -6,13 +6,16 @@ -Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object — plot.mmkin • mkin +Plot model fits (observed and fitted) and the residuals for a row or column +of an mmkin object — plot.mmkin • mkin + + @@ -32,17 +35,17 @@ - - + + + @@ -113,7 +116,6 @@ If the current plot device is a tikz device, News - @@ -129,32 +131,31 @@ If the current plot device is a tikz device,
-

Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object

+

Plot model fits (observed and fitted) and the residuals for a row or column +of an mmkin object

- -

When x is a row selected from an mmkin object ([.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 tikz device, - then latex is being used for the formatting of the chi2 error level.

- +

When x is a row selected from an mmkin object ([.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.

# S3 method for mmkin
 plot(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

- + @@ -166,21 +167,24 @@ If the current plot device is a tikz device, - + - + - + - + @@ -188,21 +192,27 @@ If the current plot device is a tikz device, - + - +
x

An object of class mmkin, with either one row or one column.

An object of class mmkin, with either one row or one +column.
main
resplot

Should the residuals plotted against time, using mkinresplot, - or as squared residuals against predicted values, with the error model, - using mkinerrplot.

Should the residuals plotted against time, using +mkinresplot, or as squared residuals against predicted +values, with the error model, using mkinerrplot.
show_errmin

Should the chi2 error level be shown on top of the plots to the left?

Should the chi2 error level be shown on top of the plots +to the left?
errmin_var

The variable for which the FOCUS chi2 error value should be shown.

The variable for which the FOCUS chi2 error value should +be shown.
errmin_digits

The number of significant digits for rounding the FOCUS chi2 error percentage.

The number of significant digits for rounding the FOCUS +chi2 error percentage.
cex
rel.height.middle

The relative height of the middle plot, if more than two rows of plots are shown.

The relative height of the middle plot, if more +than two rows of plots are shown.
...

Further arguments passed to plot.mkinfit and mkinresplot.

Further arguments passed to plot.mkinfit and +mkinresplot.
- +

Value

The function is called for its side effect.

- +

Details

+ +

If the current plot device is a tikz device, then +latex is being used for the formatting of the chi2 error level.

Examples

- 
  # \dontrun{
+    

+  # \dontrun{
   # Only use one core not to offend CRAN checks
   fits <- mmkin(c("FOMC", "HS"),
                 list("FOCUS B" = FOCUS_2006_B, "FOCUS C" = FOCUS_2006_C), # named list for titles
@@ -214,15 +224,15 @@ If the current plot device is a tikz device,
   plot(fits["FOMC", "FOCUS C"]) # same as plot(fits[1, 2])

   # Show the error models
   plot(fits["FOMC", ], resplot = "errmod")
  # }
+