Skip to content

Commit

Permalink
Doc updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
dbosak01 committed Sep 5, 2023
1 parent d2be975 commit f8a5aef
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 28 deletions.
11 changes: 4 additions & 7 deletions R/proc_freq.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
#'
Expand All @@ -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.
#' }
Expand Down
4 changes: 2 additions & 2 deletions R/proc_means.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 5 additions & 7 deletions docs/reference/proc_freq.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/reference/proc_means.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 4 additions & 7 deletions man/proc_freq.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/proc_means.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f8a5aef

Please sign in to comment.