Request a Frequency Plot — freqplot • procs

A function to request a frequency plot on a call to proc_freq. The function allows you to specify the type of frequency plot to produce, and various layout options. It supports bar charts and dot plots for one and two-way analysis. It also supports vertical or horizontal orientation, by variables, and various scale options.

freqplot(
  type = "barchart",
  orient = "vertical",
  scale = "freq",
  twoway = "groupvertical",
  groupby = "column",
  npanelpos = 4
)

Arguments

type: The type of plot to create. Valid values are "barchart" or "dotplot". Default is "barchart".
orient: The orientation of the plot. Valid values are "vertical" or "horizontal". Default is "vertical".
scale: The scale to use for the plot. Valid values are "freq", "log", "percent", or "sqrt". Default is "freq". For two-way tables, the value "grouppercent" is also valid.
twoway: Options for two-way layouts. Valid values are "cluster", "grouphorizontal", "groupvertical", or "stacked". Default is "groupvertical". This parameter applies to two-way tables only.
groupby: The variable configuration for two-way charts. Valid values are "column" or "row". Default is "column". The "row" option effectively reverses the variable configuration.
npanelpos: The number of charts per panel. Default is 4. This parameter applies to two-way tables only.

Value

The frequency plot object. This object is then passed to proc_freq for evaluation and rendering. Data from the frequency plot comes directly from the proc_freq reporting data frame.

Details

Any requested plots will be displayed on interactive reports only. Plots are created as jpeg files, and stored in a temp directory. Those temporary files are then referenced by the interactive report to display the graphic.

If desired, you may output the report objects and pass to proc_print. To do this, set output = report on the call to proc_freq, and pass the entire list to proc_print.

Examples

library(procs)

# Turn off printing for CRAN checks
# Set to TRUE to run in local environment
options("procs.print" = FALSE)

# Prepare sample data
dt <- as.data.frame(HairEyeColor, stringsAsFactors = FALSE)

# Example 1: Frequency statistics with default plots
res <- proc_freq(dt, tables = v(Hair, Eye, Hair * Eye),
                 weight = Freq,
                 output = report,
                 plots = freqplot,
                 titles = "Hair and Eye Frequency Statistics")

# View results
res

# Example 2: Frequency statistics with custom plots
res <- proc_freq(dt, tables = v(Hair, Eye, Hair * Eye),
                 weight = Freq,
                 output = report,
                 plots = list(freqplot(type = "barchart",
                                       orient = "horizontal"),
                              freqplot(type = "dotplot",
                                       scale = "percent"),
                              freqplot(type = "barchart",
                                       twoway = "cluster"),
                 titles = "Hair and Eye Frequency Statistics"))

# View results
res