From a350a16bb2c11986faf5883a2804d46b03bd7c8f Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Sat, 10 Sep 2016 05:21:52 +0200 Subject: Static documentation rebuilt with current staticdocs Using hadley/staticdocs commit #8c1069d from 8 days ago --- docs/plot.mmkin.html | 158 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 158 insertions(+) create mode 100644 docs/plot.mmkin.html (limited to 'docs/plot.mmkin.html') diff --git a/docs/plot.mmkin.html b/docs/plot.mmkin.html new file mode 100644 index 00000000..24b0d60c --- /dev/null +++ b/docs/plot.mmkin.html @@ -0,0 +1,158 @@ + + + + +plot.mmkin. mkin 0.9.44.9000 + + + + + + + + + + + + + + + +
+
+
+ mkin 0.9.44.9000 +
+ +
+
+
+
+ + +
+
+ +
+ +

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

+ +
+
+

Usage

+ 
# S3 method for mmkin
+plot(x, main = "auto", legends = 1, errmin_var = "All data", errmin_digits = 3,
+              cex = 0.7, rel.height.middle = 0.9, ...)
+ +

Arguments

+
+
x
+
+ An object of class mmkin, with either one row or one column. +
+
main
+
+ The main title placed on the outer margin of the plot. +
+
legends
+
+ An index for the fits for which legends should be shown. +
+
errmin_var
+
+ 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. +
+
cex
+
+ Passed to the plot functions and mtext. +
+
rel.height.middle
+
+ The relative height of the middle plot, if more than two rows of plots are shown. +
+
...
+
+ Further arguments passed to plot.mkinfit and mkinresplot. +
+
+ +
+

Description

+ +

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.

+ +
+ +
+

Value

+ +

+ The function is called for its side effect. +

+ +
+ +

Examples

+ 
  # Only use one core not to offend CRAN checks, use Levenberg-Marquardt for speed
+  fits <- mmkin(c("FOMC", "HS"), list("FOCUS B" = FOCUS_2006_B, "FOCUS C" = FOCUS_2006_C),
+                cores = 1, quiet = TRUE, method.modFit = "Marq")
+  plot(fits[, "FOCUS C"])

+

+
  plot(fits["FOMC", ])

+

+

+  # We can also plot a single fit, if we like the way mmkin works, but then the plot 
+  # height should be smaller than the plot width (this is not possible for the html pages
+  # generated by staticdocs, as far as I know).
+  plot(fits["FOMC", "FOCUS C"]) # same as plot(fits[1, 2])

+
+
+
+ + + + +

Author

+ + Johannes Ranke + + +
+
+ + +
+ + \ No newline at end of file -- cgit v1.2.1