From e05656d57668688b971c28e32b4cfd4d3eac4662 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 18 Sep 2019 13:03:50 +0200 Subject: Correct and rebuild docs - Reconcile docs and code for max_twa_parent - Correct links to docs in twa vignette - Static documentation rebuilt by pkgdown --- docs/reference/plot.mmkin.html | 46 +++++++++++++++++++++++++++--------------- 1 file changed, 30 insertions(+), 16 deletions(-) (limited to 'docs/reference/plot.mmkin.html') diff --git a/docs/reference/plot.mmkin.html b/docs/reference/plot.mmkin.html index ef734bc8..9a11108f 100644 --- a/docs/reference/plot.mmkin.html +++ b/docs/reference/plot.mmkin.html @@ -16,13 +16,15 @@ - + + - - + + + @@ -51,6 +53,7 @@ If the current plot device is a tikz device, + @@ -120,6 +123,7 @@ If the current plot device is a tikz device, +
@@ -135,15 +139,15 @@ If the current plot device is a tikz device,

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, +

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

# S3 method for mmkin
-plot(x, main = "auto", legends = 1,
-  resplot = c("time", "errmod"), errmin_var = "All data", errmin_digits = 3,
-  cex = 0.7, rel.height.middle = 0.9, ...)
+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, ...)

Arguments

@@ -166,6 +170,10 @@ If the current plot device is a tikz device, or as squared residuals against predicted values, with the error model, using mkinerrplot.

+ + + + @@ -176,14 +184,14 @@ If the current plot device is a tikz device, - + - +
show_errmin

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.

cex

Passed to the plot functions and mtext.

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.
@@ -194,17 +202,19 @@ If the current plot device is a tikz device,

Examples

- 
  
  # 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
+    
  # \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
                 cores = 1, quiet = TRUE, error_model = "tc")
#> Warning: Optimisation did not converge:
-#> iteration limit reached without convergence (10)
  plot(fits[, "FOCUS C"])
  plot(fits["FOMC", ])

+#> iteration limit reached without convergence (10)
  plot(fits[, "FOCUS C"])
  plot(fits["FOMC", ])

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

+  plot(fits["FOMC", "FOCUS C"]) # same as plot(fits[1, 2])

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

+  plot(fits["FOMC", ], resplot = "errmod")
  # }
+
+ + + -- cgit v1.2.1