diff --git a/R/proc_freq.R b/R/proc_freq.R index fa924a7..d88dda0 100644 --- a/R/proc_freq.R +++ b/R/proc_freq.R @@ -23,7 +23,7 @@ #' be immediately sent to the viewer as an HTML report. This functionality #' makes it easy to get a quick analysis of your data with very little #' effort. To turn off the interactive report, pass the "noprint" keyword -#' to the \code{options} parameter. +#' to the \code{options} parameter or set \code{options("procs.print" = FALSE)}. #' #' The \code{titles} parameter allows you to set one or more titles for your #' report. Pass these titles as a vector of strings. @@ -61,7 +61,7 @@ #' input data equally. In some cases, however, each row in the data #' can represent multiple observations, and rows should not be treated #' equally. In these cases, use the \code{weight} parameter. The parameter -#' accepts a quoted variable/column name to use as the weighted value. If the +#' accepts a variable/column name to use as the weighted value. If the #' \code{weight} parameter is used, the function will sum the weighted values #' instead of counting rows. #' @@ -77,14 +77,11 @@ #' @section Options: #' The \code{options} parameter accepts a vector of options. Normally, these #' options must be quoted. But you may pass them unquoted using the \code{v()} -#' function. For example, you can request report datasets and the Chi-Square -#' statistic like this: \code{options = v(nlevels, chisq)}. +#' function. For example, you can request the number of category levels +#' and the Chi-Square statistic like this: \code{options = v(nlevels, chisq)}. #' #' Below are all the available options and a description of each: #' \itemize{ -#' \item{\strong{chisq}: Requests that the Chi-square statistics be produced. -#' This option is only valid on two-way tables. -#' } #' \item{\strong{crosstab}: Two-way output tables are a list style by default. #' If you want a crosstab style, pass the "crosstab" option. #' } diff --git a/R/proc_means.R b/R/proc_means.R index 6685869..6696650 100644 --- a/R/proc_means.R +++ b/R/proc_means.R @@ -21,8 +21,8 @@ #' @section Interactive Output: #' By default, \code{proc_freq} results will #' be immediately sent to the viewer as an HTML report. This functionality -#' makes it easy to get a quick analysis of your data with very little -#' effort. To turn off the interactive report, pass the "noprint" keyword +#' makes it easy to get a quick analysis of your data. To turn off the +#' interactive report, pass the "noprint" keyword #' to the \code{options} parameter. #' #' The \code{titles} parameter allows you to set one or more titles for your diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 1bf3fc0..2a3c6e1 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -10,7 +10,7 @@ articles: procs-freq: procs-freq.html procs-means: procs-means.html procs: procs.html -last_built: 2023-09-04T23:09Z +last_built: 2023-09-05T00:04Z urls: reference: https://procs.r-sassy.org/reference article: https://procs.r-sassy.org/articles diff --git a/docs/reference/proc_freq.html b/docs/reference/proc_freq.html index ad99970..b3a5e13 100644 --- a/docs/reference/proc_freq.html +++ b/docs/reference/proc_freq.html @@ -200,7 +200,7 @@

Report Output

be immediately sent to the viewer as an HTML report. This functionality makes it easy to get a quick analysis of your data with very little effort. To turn off the interactive report, pass the "noprint" keyword -to the options parameter.

+to the options parameter or set options("procs.print" = FALSE).

The titles parameter allows you to set one or more titles for your report. Pass these titles as a vector of strings.

If the frequency variables have a label assigned, that label @@ -239,7 +239,7 @@

Frequency Weight

input data equally. In some cases, however, each row in the data can represent multiple observations, and rows should not be treated equally. In these cases, use the weight parameter. The parameter -accepts a quoted variable/column name to use as the weighted value. If the +accepts a variable/column name to use as the weighted value. If the weight parameter is used, the function will sum the weighted values instead of counting rows.

@@ -261,11 +261,9 @@

Options

The options parameter accepts a vector of options. Normally, these options must be quoted. But you may pass them unquoted using the v() -function. For example, you can request report datasets and the Chi-Square -statistic like this: options = v(nlevels, chisq).

-

Below are all the available options and a description of each: