update documentation for scaspci & scoreci to account for changes to …

…bcf argument
petelaud · Feb 15, 2025 · 9efd1df · 9efd1df
1 parent 3708413
commit 9efd1df
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 5 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -32,7 +32,6 @@ BugReports: https://github.com/petelaud/ratesci/issues
 Depends: 
     R (>= 3.6.0)
 Imports:
-    polynom
 Suggests: 
     testthat
 Encoding: UTF-8

diff --git a/R/rateci.R b/R/rateci.R
@@ -9,6 +9,10 @@
 #'   data: "bin" = binomial (default), "poi" = Poisson.
 #' @param level Number specifying confidence level (between 0 and 1, default
 #'   0.95).
+#' @param bcf Logical (default TRUE) indicating whether to apply bias correction
+#'   in the score denominator. Applicable to distrib = "bin" only.
+#' @param bign Sample size N to be used in the calculation of bcf, if different
+#'   from n.
 #' @param cc Number or logical (default FALSE) specifying (amount of) continuity
 #'   correction. Numeric value is taken as the gamma parameter in Laud 2017,
 #'   Appendix S2 (default 0.5 for 'conventional' correction if cc = TRUE).

diff --git a/R/scoreci.R b/R/scoreci.R
@@ -49,7 +49,6 @@
 #'   in the score denominator. Applicable to distrib = "bin" only. (NB: bcf =
 #'   FALSE option is really only included for legacy validation against previous
 #'   published methods (i.e. Gart & Nam, Mee, or standard Chi-squared test).
-#'   Ignored for contrast = "p".
 #' @param cc Number or logical (default FALSE) specifying (amount of) continuity
 #'   correction. Numeric value is taken as the gamma parameter in Laud 2017,
 #'   Appendix S2 (default 0.5 for 'conventional' correction if cc = TRUE).

diff --git a/man/scaspci.Rd b/man/scaspci.Rd
diff --git a/man/scoreci.Rd b/man/scoreci.Rd