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/loq.html | 99 ++++++++++++++++++++++++++----------------------- 1 file changed, 53 insertions(+), 46 deletions(-) (limited to 'docs/reference/loq.html') diff --git a/docs/reference/loq.html b/docs/reference/loq.html index 0960251..86c8f43 100644 --- a/docs/reference/loq.html +++ b/docs/reference/loq.html @@ -1,11 +1,10 @@ -Estimate a limit of quantification (LOQ) — loq • chemCalEstimate a limit of quantification (LOQ) — loq • chemCal @@ -53,69 +52,75 @@
-

The limit of quantification is the x value, where the relative error - of the quantification given the calibration model reaches a prespecified - value 1/k. Thus, it is the solution of the equation - $$L = k c(L)$$ - where c(L) is half of the length of the confidence interval at the limit L - (DIN 32645, equivalent to ISO 11843). c(L) is internally estimated by - inverse.predict, and L is obtained by iteration.

+

The limit of quantification is the x value, where the relative error of the +quantification given the calibration model reaches a prespecified value 1/k. +Thus, it is the solution of the equation $$L = k c(L)$$ +where c(L) is half of the length of the confidence interval at the limit L +(DIN 32645, equivalent to ISO 11843). c(L) is internally estimated by +inverse.predict, and L is obtained by iteration.

-
loq(object, ..., alpha = 0.05, k = 3, n = 1, w.loq = "auto",
-    var.loq = "auto", tol = "default")
+
loq(
+  object,
+  ...,
+  alpha = 0.05,
+  k = 3,
+  n = 1,
+  w.loq = "auto",
+  var.loq = "auto",
+  tol = "default"
+)

Arguments

object
-

A univariate model object of class lm or - rlm - with model formula y ~ x or y ~ x - 1, - optionally from a weighted regression. If weights are specified - in the model, either w.loq or var.loq have to - be specified.

-
alpha
-

The error tolerance for the prediction of x values in the calculation.

+

A univariate model object of class lm or +rlm with model formula y ~ x or y ~ x - +1, optionally from a weighted regression. If weights are specified in the +model, either w.loq or var.loq have to be specified.

...
-

Placeholder for further arguments that might be needed by - future implementations.

+

Placeholder for further arguments that might be needed by +future implementations.

+
alpha
+

The error tolerance for the prediction of x values in the +calculation.

k
-

The inverse of the maximum relative error tolerated at the - desired LOQ.

+

The inverse of the maximum relative error tolerated at the desired +LOQ.

n

The number of replicate measurements for which the LOQ should be - specified.

+specified.

w.loq
-

The weight that should be attributed to the LOQ. Defaults - to one for unweighted regression, and to the mean of the weights - for weighted regression. See massart97ex3 for - an example how to take advantage of knowledge about the - variance function.

+

The weight that should be attributed to the LOQ. Defaults to +one for unweighted regression, and to the mean of the weights for weighted +regression. See massart97ex3 for an example how to take +advantage of knowledge about the variance function.

var.loq
-

The approximate variance at the LOQ. The default value is - calculated from the model.

+

The approximate variance at the LOQ. The default value is +calculated from the model.

tol
-

The default tolerance for the LOQ on the x scale is the value of the - smallest non-zero standard divided by 1000. Can be set to a - numeric value to override this.

+

The default tolerance for the LOQ on the x scale is the value of +the smallest non-zero standard divided by 1000. Can be set to a numeric +value to override this.

Value

-

The estimated limit of quantification for a model used for calibration.

+

The estimated limit of quantification for a model used for +calibration.

Note

-

- IUPAC recommends to base the LOQ on the standard deviation of the signal - where x = 0. - - The calculation of a LOQ based on weighted regression is non-standard - and therefore not tested. Feedback is welcome.

+

* IUPAC recommends to base the LOQ on the standard deviation of the +signal where x = 0. +* The calculation of a LOQ based on weighted regression is non-standard and +therefore not tested. Feedback is welcome.

See also

@@ -124,7 +129,8 @@

Examples

-
m <- lm(y ~ x, data = massart97ex1)
+    

+m <- lm(y ~ x, data = massart97ex1)
 loq(m)
 #> $x
 #> [1] 13.97764
@@ -141,6 +147,7 @@
 #> $y
 #> [1] 22.68539
 #> 
+
 
-- cgit v1.2.1