topline: weighted topline

View source: R/Topline.R

toplineR Documentation

weighted topline

Description

topline returns a tibble containing a weighted topline of one variable

Usage

topline(
  df,
  variable,
  weight,
  remove = c(""),
  n = TRUE,
  pct = TRUE,
  valid_pct = TRUE,
  cum_pct = TRUE
)

Arguments

df

The data source

variable

the variable name

weight

The weighting variable, defaults to zwave_weight

remove

An optional character vector of values to remove from final table (e.g. "refused"). This will not affect any calculations made. The vector is not case-sensitive.

n

logical, if TRUE a frequency column is included percentages, but in a separate row for column percentages.

pct

logical, if TRUE a column of percents is included

valid_pct

logical, if TRUE a column of valid percents is included

cum_pct

logical, if TRUE a column of cumulative percents is included

Details

By default the table includes a column for frequency count, percent, valid percent, and cumulative percent.

Value

a tibble

Examples

topline(illinois, sex, weight)
topline(illinois, sex, weight, pct = FALSE)

pollster documentation built on May 31, 2023, 7:39 p.m.