Checks #115 and disp example #116

R/proc_freq.R

@@ -88,9 +88,6 @@
 #' \item{\strong{crosstab}: Two-way output tables are a list style by default.
 #' If you want a crosstab style, pass the "crosstab" option.
 #' }
-#' \item{\strong{fisher}: Requests that the Fisher's exact statistics be produced.
-#' This option is only valid on two-way tables.
-#' }
 #' \item{\strong{list}: Two-way interactive tables are a crosstab style
 #' by default.  If you want a list style two-way table, pass the "list" option.
 #' }
@@ -143,7 +140,17 @@
 #' on output frequency tables.  By default, these columns are not included.
 #' The "outcum" option will include them.
 #' }
-
+#' }
+#' @section Statistics Options:
+#' In addition to the above options, the \code{options} parameter accepts
+#' some statistics options.  The following keywords will generate
+#' an additional tables of specialized statistics. These statistics
+#' options are only available on two-way tables:
+#' \itemize{
+#' \item{\strong{chisq}: Requests that the Chi-square statistics be produced.
+#' }
+#' \item{\strong{fisher}: Requests that the Fisher's exact statistics be produced.
+#' }
 #' }
 #' @section Using Factors:
 #' There are some occasions when you may want to define the \code{tables} variable
@@ -397,20 +404,6 @@ proc_freq <- function(data,
                     #  plots = NULL
                       ) {
 
-  kopts <- c("noprint",
-             "list", "nocol", "nocum", "nofreq", "nopercent",
-             "norow", "nosparse", "outcum",
-             "sparse", "crosstab",
-             "notable", "nonobs", "missing", "nlevels",
-             "wide", "long", "stacked")  # vector not used
-
-  outopts <- c("out", "report", "none")
-
-  # "expected", "outexpect", "missprint"
-
-  vstats <- c("chisq", "cl", "fisher") # vector not used
-
-  nopts <- c("alpha", "maxlevels", "out") # vector not used
 
   # Deal with single value unquoted parameter values
   oby <- deparse(substitute(by, env = environment()))
@@ -473,6 +466,26 @@ proc_freq <- function(data,
 
   }
 
+  if (!is.null(options)) {
+    kopts <- c("noprint",
+               "list", "nocol", "nocum", "nofreq", "nopercent",
+               "norow", "nosparse", "outcum",
+               "sparse", "crosstab",
+               "notable", "nonobs", "missing", "nlevels",
+               "chisq", "fisher", # Statistics options
+               "alpha" # Setting options
+               )
+
+    # Future options
+    # "expected", "outexpect", "missprint", "cl", "maxlevels"
+
+    if (!all(tolower(options) %in% kopts)) {
+
+      stop(paste("Invalid options keyword: ", options[!tolower(options) %in% kopts], "\n"))
+    }
+
+  }
+
   # Set default statistics for output parameters
   if (has_output(output))
     outreq <- get_output_specs(tables, list(), options, output)

R/proc_means.R

@@ -223,7 +223,7 @@
 #' will be nested in the \code{by}.
 # @param weight An optional weight parameter.
 #' @param options A vector of optional keywords. Valid values are: "alpha =",
-#' "completetypes", "long", "maxdec", "noprint", "notype, "nofreq", "nonobs".
+#' "completetypes", "maxdec =", "noprint", "notype", "nofreq", "nonobs".
 #' The "notype", "nofreq", and "nonobs" keywords will turn
 #' off columns on the output datasets.  The "alpha = " option will set the alpha
 #' value for confidence limit statistics.  The default is 95% (alpha = 0.05).
@@ -390,7 +390,7 @@ proc_means <- function(data,
   if (!is.null(class)) {
     if (!all(class %in% nms)) {
 
-      stop(paste("Invalid variable name: ", class[!class %in% nms], "\n"))
+      stop(paste("Invalid class name: ", class[!class %in% nms], "\n"))
     }
   }
 
@@ -419,6 +419,22 @@ proc_means <- function(data,
 
   }
 
+  if (!is.null(options)) {
+    kopts <- c("alpha", "completetypes", "long", "maxdec",
+               "noprint", "notype", "nofreq", "nonobs")
+
+    # Deal with "alpha =" and "maxdec = " by using name instead of value
+    nopts <- names(options)
+    mopts <- ifelse(nopts == "", options, nopts)
+
+
+    if (!all(tolower(mopts) %in% kopts)) {
+
+      stop(paste("Invalid options keyword: ", mopts[!tolower(mopts) %in% kopts], "\n"))
+    }
+  }
+
+
   # Generate output specs
   if (has_output(output))
     outreq <- get_output_specs_means(list(), stats, options, output)

_pkgdown.yml

@@ -9,6 +9,7 @@ articles:
   - procs-dm
   - procs-example1
   - procs-example2
+  - procs-example3
   - procs-faq
 
 reference: