luca-scr / qcc

An R package for Quality Control Charts
https://luca-scr.github.io/qcc/
43 stars 17 forks source link

Man page for oc.curves #3

Closed PeterBloomfield closed 9 years ago

PeterBloomfield commented 9 years ago

Luca:

Here's a patch for oc.curves.Rd. It adds oc.curves.R, and explains a bit more about the nsigmas argument. If it looks OK to you, I'll commit it and send you a pull request.

Peter

diff --git a/man/oc.curves.Rd b/man/oc.curves.Rd
index 574cc01..b29908a 100644
--- a/man/oc.curves.Rd
+++ b/man/oc.curves.Rd
@@ -11,6 +11,9 @@ oc.curves(object, \dots)
 oc.curves.xbar(object, n, c = seq(0, 5, length=101), 
                nsigmas = object$nsigmas, identify=FALSE, restore.par=TRUE)

+oc.curves.R(object, n, c = seq(1, 6, length=101),
+            nsigmas = object$nsigmas, identify = FALSE, restore.par=TRUE)
+
 oc.curves.p(object, nsigmas = object$nsigmas, identify = FALSE, restore.par=TRUE)

 oc.curves.c(object, nsigmas = object$nsigmas, identify = FALSE, restore.par=TRUE)
@@ -21,7 +24,10 @@ oc.curves.c(object, nsigmas = object$nsigmas, identify = FALSE, restore.par=TRUE
 \item{identify}{logical specifying whether to interactively identify points on the plot (see help for \code{\link{identify}}).}
 \item{n}{a vector of values specifying the sample sizes for which to draw the OC curves.}
 \item{c}{a vector of values specifying the multipliers for sigma in case of continuous variable.}
-\item{nsigmas}{a numeric value specifying th number of sigmas to use for computing control limits.}
+\item{nsigmas}{a numeric value specifying the number of sigmas to use for
+computing control limits; if \code{nsigmas} is \code{NULL},
+\code{object$conf} is used to set up probability limits; \code{nsigmas}
+is ignored for types "p" and "c".}
 \item{restore.par}{a logical value indicating whether the previous \code{par} settings must be restored. If you need to add points, lines, etc. to a chart set this to \code{FALSE}.}
 \item{\dots}{additional arguments to be passed to the generic function.}
 }
PeterBloomfield commented 9 years ago

Oops: it also needs another \alias line.

PeterBloomfield commented 9 years ago

Fat finger--hit the wrong button :)

luca-scr commented 9 years ago

ok