From f820bf5b91be0f589de16c3e3250f5f79672df75 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Fri, 28 Oct 2022 13:39:15 +0200
Subject: Rename parhist to parplot and make it generic

That parhist name was not the brightest idea, as it does
not show histograms.
---
 man/parplot.Rd | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 man/parplot.Rd

(limited to 'man/parplot.Rd')

diff --git a/man/parplot.Rd b/man/parplot.Rd
new file mode 100644
index 00000000..37c5841d
--- /dev/null
+++ b/man/parplot.Rd
@@ -0,0 +1,46 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/parplot.R
+\name{parplot}
+\alias{parplot}
+\alias{parplot.multistart.saem.mmkin}
+\title{Plot parameter variability of multistart objects}
+\usage{
+parplot(object, ...)
+
+\method{parplot}{multistart.saem.mmkin}(
+  object,
+  llmin = -Inf,
+  scale = c("best", "median"),
+  lpos = "bottomleft",
+  main = "",
+  ...
+)
+}
+\arguments{
+\item{object}{The \link{multistart} object}
+
+\item{\dots}{Passed to \link{boxplot}}
+
+\item{llmin}{The minimum likelihood of objects to be shown}
+
+\item{scale}{By default, scale parameters using the best available fit.
+If 'median', parameters are scaled using the median parameters from all fits.}
+
+\item{lpos}{Positioning of the legend.}
+
+\item{main}{Title of the plot}
+}
+\description{
+Produces a boxplot with all parameters from the multiple runs, scaled
+either by the parameters of the run with the highest likelihood,
+or by their medians as proposed in the paper by Duchesne et al. (2021).
+}
+\references{
+Duchesne R, Guillemin A, Gandrillon O, Crauste F. Practical
+identifiability in the frame of nonlinear mixed effects models: the example
+of the in vitro erythropoiesis. BMC Bioinformatics. 2021 Oct 4;22(1):478.
+doi: 10.1186/s12859-021-04373-4.
+}
+\seealso{
+\link{multistart}
+}
-- 
cgit v1.2.1