From 08465d77a6ca5a9656ac86047c6008f1e7f3e9c7 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 31 Mar 2022 19:21:03 +0200 Subject: Fix URLs in README, convert to roxygen - The roxygen conversion was done using Rd2roxygen - Also edit _pkgdown.yml to group the reference - Use markdown bullet lists for lod and loq docs --- docs/reference/calplot.html | 154 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 154 insertions(+) create mode 100644 docs/reference/calplot.html (limited to 'docs/reference/calplot.html') diff --git a/docs/reference/calplot.html b/docs/reference/calplot.html new file mode 100644 index 0000000..88321b1 --- /dev/null +++ b/docs/reference/calplot.html @@ -0,0 +1,154 @@ + +Plot calibration graphs from univariate linear models — calplot • chemCal + + +
+
+ + + +
+
+
+

Plot calibration graphs from univariate linear models

+ Source: R/calplot.R + +
+ +
+

Produce graphics of calibration data, the fitted model as well as +confidence, and, for unweighted regression, prediction bands.

+
+ +
+ 
calplot(
+  object,
+  xlim = c("auto", "auto"),
+  ylim = c("auto", "auto"),
+  xlab = "Concentration",
+  ylab = "Response",
+  legend_x = "auto",
+  alpha = 0.05,
+  varfunc = NULL
+)
+
+ +
+

Arguments

+
object
+

A univariate model object of class lm or +rlm with model formula y ~ x or y ~ x - +1.

+
xlim
+

The limits of the plot on the x axis.

+
ylim
+

The limits of the plot on the y axis.

+
xlab
+

The label of the x axis.

+
ylab
+

The label of the y axis.

+
legend_x
+

An optional numeric value for adjusting the x coordinate of +the legend.

+
alpha
+

The error tolerance level for the confidence and prediction +bands. Note that this includes both tails of the Gaussian distribution, +unlike the alpha and beta parameters used in lod (see note +below).

+
varfunc
+

The variance function for generating the weights in the +model. Currently, this argument is ignored (see note below).

+
+
+

Value

+

A plot of the calibration data, of your fitted model as well as +lines showing the confidence limits. Prediction limits are only shown for +models from unweighted regression.

+
+
+

Note

+

Prediction bands for models from weighted linear regression require +weights for the data, for which responses should be predicted. Prediction +intervals using weights e.g. from a variance function are currently not +supported by the internally used function predict.lm, +therefore, calplot does not draw prediction bands for such models.

+

It is possible to compare the calplot prediction bands with +the lod values if the lod() alpha and beta parameters +are half the value of the calplot() alpha parameter.

+
+
+

Author

+

Johannes Ranke

+
+ +
+

Examples

+ 

+data(massart97ex3)
+m <- lm(y ~ x, data = massart97ex3)
+calplot(m)
+
+
+
+
+
+ +
+ + +
+ + + + + + + + -- cgit v1.2.1