From 6ad4e443b662e8c61b1b350d3e639e821a8ff764 Mon Sep 17 00:00:00 2001
From: Johannes Ranke
Date: Sat, 24 Oct 2020 01:42:54 +0200
Subject: Improve plot layout
---
R/plot.nlme.mmkin.R | 46 +++++++++----------------------
docs/dev/pkgdown.yml | 2 +-
docs/dev/reference/Rplot002.png | Bin 63682 -> 64132 bytes
docs/dev/reference/plot.nlme.mmkin-2.png | Bin 177237 -> 179274 bytes
docs/dev/reference/plot.nlme.mmkin.html | 21 ++++----------
man/plot.nlme.mmkin.Rd | 15 +++-------
6 files changed, 23 insertions(+), 61 deletions(-)
diff --git a/R/plot.nlme.mmkin.R b/R/plot.nlme.mmkin.R
index 084099ac..2356070e 100644
--- a/R/plot.nlme.mmkin.R
+++ b/R/plot.nlme.mmkin.R
@@ -10,9 +10,7 @@ if(getRversion() >= '2.15.1') utils::globalVariables("ds")
#' @param legends An index for the fits for which legends should be shown.
#' @param standardized Should the residuals be standardized? Only takes effect if
#' `resplot = "time"`.
-#' @param cex Passed to the plot functions and \code{\link{mtext}}.
-#' @param rel.height.middle The relative height of the middle plot, if more
-#' than two rows of plots are shown.
+#' @param rel.height.bottom The relative height of the bottom plot row
#' @param ymax Vector of maximum y axis values
#' @param \dots Further arguments passed to \code{\link{plot.mkinfit}} and
#' \code{\link{mkinresplot}}.
@@ -36,20 +34,20 @@ if(getRversion() >= '2.15.1') utils::globalVariables("ds")
#' library(nlme)
#' # For this fit we need to increase pnlsMaxiter, and we increase the
#' # tolerance in order to speed up the fit for this example evaluation
-#' f_nlme <- nlme(f, control = list(pnlsMaxIter = 120, tolerance = 1e-4))
+#' f_nlme <- nlme(f, control = list(pnlsMaxIter = 120, tolerance = 1e-3))
#' plot(f_nlme)
#' @export
plot.nlme.mmkin <- function(x, i = 1:ncol(x$mmkin_orig),
- main = rownames(x$mmkin_orig),
+ main = NULL,
obs_vars = names(x$mkinmod$map),
standardized = TRUE,
- xlab = "Time", ylab = "Observed",
+ xlab = "Time",
xlim = range(x$data$time),
legends = 1,
lpos = "topright", inset = c(0.05, 0.05),
resplot = c("predicted", "time"),
ymax = "auto", maxabs = "auto",
- cex = 0.7, rel.height.middle = 0.9,
+ rel.height.bottom = 1.1,
pch_ds = 1:length(i),
col_ds = pch_ds + 1,
lty_ds = col_ds,
@@ -82,11 +80,7 @@ plot.nlme.mmkin <- function(x, i = 1:ncol(x$mmkin_orig),
# Set relative plot heights, so the first and the last plot are the norm
# and the middle plots (if n_plot_rows >2) are smaller by rel.height.middle
- rel.heights <- if (n_plot_rows > 2) {
- c(1, rep(rel.height.middle, n_plot_rows - 2), 1)
- } else {
- rep(1, n_plot_rows)
- }
+ rel.heights <- if (n_plot_rows > 1) c(rep(1, n_plot_rows - 1), rel.height.bottom) else 1
layout_matrix = matrix(1:n_plots,
n_plot_rows, 2, byrow = TRUE)
@@ -145,31 +139,18 @@ plot.nlme.mmkin <- function(x, i = 1:ncol(x$mmkin_orig),
ylim_row = c(0, ymax[plot_row])
}
- # Margins for top row of plots when we have more than one row
- # Reduce bottom margin by 2.1 - hides x axis legend
- if (plot_row == 1 & n_plot_rows > 1) {
- par(mar = c(3.0, 4.1, 4.1, 2.1))
- }
-
- # Margins for middle rows of plots, if any
- if (plot_row > 1 & plot_row < n_plot_rows) {
- # Reduce top margin by 2 after the first plot as we have no main title,
- # reduced plot height, therefore we need rel.height.middle in the layout
- par(mar = c(3.0, 4.1, 2.1, 2.1))
- }
-
# Margins for bottom row of plots when we have more than one row
- if (plot_row == n_plot_rows & n_plot_rows > 1) {
- # Restore bottom margin for last plot to show x axis legend
+ # This is the only row that needs to show the x axis legend
+ if (plot_row == n_plot_rows) {
par(mar = c(5.1, 4.1, 2.1, 2.1))
+ } else {
+ par(mar = c(3.0, 4.1, 2.1, 2.1))
}
plot(pred_pop$time, pred_pop[[obs_var]],
- main = obs_var,
type = "l", lwd = 2,
xlim = xlim, ylim = ylim_row,
- xlab = xlab, ylab = ylab, frame = frame,
- cex = cex)
+ xlab = xlab, ylab = obs_var, frame = frame)
for (ds_i in seq_along(i)) {
points(subset(observed_row, ds == ds_names[ds_i], c("time", "value")),
@@ -180,7 +161,7 @@ plot.nlme.mmkin <- function(x, i = 1:ncol(x$mmkin_orig),
if (plot_row %in% legends) {
legend(lpos, inset = inset,
- legend = c("Population mean", ds_names[i]),
+ legend = c("Population", ds_names[i]),
lty = c(1, lty_ds), lwd = c(2, rep(1, length(i))),
col = c(1, col_ds),
pch = c(NA, pch_ds))
@@ -193,9 +174,9 @@ plot.nlme.mmkin <- function(x, i = 1:ncol(x$mmkin_orig),
if (identical(resplot, "time")) {
plot(0, type = "n", xlim = xlim, xlab = "Time",
- main = obs_var,
ylim = c(-1.2 * maxabs, 1.2 * maxabs),
ylab = if (standardized) "Standardized residual" else "Residual")
+
abline(h = 0, lty = 2)
for (ds_i in seq_along(i)) {
@@ -206,7 +187,6 @@ plot.nlme.mmkin <- function(x, i = 1:ncol(x$mmkin_orig),
if (identical(resplot, "predicted")) {
plot(0, type = "n",
- main = obs_var,
xlim = c(0, max(pred_ds[[obs_var]])),
xlab = "Predicted",
ylim = c(-1.2 * maxabs, 1.2 * maxabs),
diff --git a/docs/dev/pkgdown.yml b/docs/dev/pkgdown.yml
index 8c97cd7c..61fa6e5d 100644
--- a/docs/dev/pkgdown.yml
+++ b/docs/dev/pkgdown.yml
@@ -10,7 +10,7 @@ articles:
web_only/NAFTA_examples: NAFTA_examples.html
web_only/benchmarks: benchmarks.html
web_only/compiled_models: compiled_models.html
-last_built: 2020-10-23T22:30Z
+last_built: 2020-10-23T23:38Z
urls:
reference: https://pkgdown.jrwb.de/mkin/reference
article: https://pkgdown.jrwb.de/mkin/articles
diff --git a/docs/dev/reference/Rplot002.png b/docs/dev/reference/Rplot002.png
index 71c768bd..cffa10c1 100644
Binary files a/docs/dev/reference/Rplot002.png and b/docs/dev/reference/Rplot002.png differ
diff --git a/docs/dev/reference/plot.nlme.mmkin-2.png b/docs/dev/reference/plot.nlme.mmkin-2.png
index 57128ade..4ec26146 100644
Binary files a/docs/dev/reference/plot.nlme.mmkin-2.png and b/docs/dev/reference/plot.nlme.mmkin-2.png differ
diff --git a/docs/dev/reference/plot.nlme.mmkin.html b/docs/dev/reference/plot.nlme.mmkin.html
index f17a23e3..c633e15a 100644
--- a/docs/dev/reference/plot.nlme.mmkin.html
+++ b/docs/dev/reference/plot.nlme.mmkin.html
@@ -151,11 +151,10 @@
plot(
x,
i = 1:ncol(x$mmkin_orig),
- main = rownames(x$mmkin_orig),
+ main = NULL,
obs_vars = names(x$mkinmod$map),
standardized = TRUE,
xlab = "Time",
- ylab = "Observed",
xlim = range(x$data$time),
legends = 1,
lpos = "topright",
@@ -163,8 +162,7 @@
resplot = c("predicted", "time"),
ymax = "auto",
maxabs = "auto",
- cex = 0.7,
- rel.height.middle = 0.9,
+ rel.height.bottom = 1.1,
pch_ds = 1:length(i),
col_ds = pch_ds + 1,
lty_ds = col_ds,
@@ -203,10 +201,6 @@ variables in the model.
xlab |
Label for the x axis. |
-
- ylab |
- Label for the y axis. |
-
xlim |
Plot range in x direction. |
@@ -240,13 +234,8 @@ predicted values?
scaling of the y axis and defaults to "auto".
- 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. |
+ rel.height.bottom |
+ The relative height of the bottom plot row |
pch_ds |
@@ -290,7 +279,7 @@ corresponding model prediction lines for the different datasets.
diff --git a/man/plot.nlme.mmkin.Rd b/man/plot.nlme.mmkin.Rd
index d1fde212..5f6e4ed3 100644
--- a/man/plot.nlme.mmkin.Rd
+++ b/man/plot.nlme.mmkin.Rd
@@ -7,11 +7,10 @@
\method{plot}{nlme.mmkin}(
x,
i = 1:ncol(x$mmkin_orig),
- main = rownames(x$mmkin_orig),
+ main = NULL,
obs_vars = names(x$mkinmod$map),
standardized = TRUE,
xlab = "Time",
- ylab = "Observed",
xlim = range(x$data$time),
legends = 1,
lpos = "topright",
@@ -19,8 +18,7 @@
resplot = c("predicted", "time"),
ymax = "auto",
maxabs = "auto",
- cex = 0.7,
- rel.height.middle = 0.9,
+ rel.height.bottom = 1.1,
pch_ds = 1:length(i),
col_ds = pch_ds + 1,
lty_ds = col_ds,
@@ -45,8 +43,6 @@ variables in the model.}
\item{xlab}{Label for the x axis.}
-\item{ylab}{Label for the y axis.}
-
\item{xlim}{Plot range in x direction.}
\item{legends}{An index for the fits for which legends should be shown.}
@@ -65,10 +61,7 @@ predicted values?}
\item{maxabs}{Maximum absolute value of the residuals. This is used for the
scaling of the y axis and defaults to "auto".}
-\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{rel.height.bottom}{The relative height of the bottom plot row}
\item{pch_ds}{Symbols to be used for plotting the data.}
@@ -99,7 +92,7 @@ plot(f[, 3:4], standardized = TRUE)
library(nlme)
# For this fit we need to increase pnlsMaxiter, and we increase the
# tolerance in order to speed up the fit for this example evaluation
-f_nlme <- nlme(f, control = list(pnlsMaxIter = 120, tolerance = 1e-4))
+f_nlme <- nlme(f, control = list(pnlsMaxIter = 120, tolerance = 1e-3))
plot(f_nlme)
}
\author{
--
cgit v1.2.1