topline: weighted topline

Description Usage Arguments Details Value Examples

View source: R/Topline.R

Description

topline returns a tibble containing a weighted topline of one variable

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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

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

Example output

# A tibble: 2 x 5
  Response Frequency Percent `Valid Percent` `Cumulative Percent`
  <fct>        <dbl>   <dbl>           <dbl>                <dbl>
1 Male     49108796.    47.8            47.8                 47.8
2 Female   53569718.    52.2            52.2                100  
# A tibble: 2 x 4
  Response Frequency `Valid Percent` `Cumulative Percent`
  <fct>        <dbl>           <dbl>                <dbl>
1 Male     49108796.            47.8                 47.8
2 Female   53569718.            52.2                100  

pollster documentation built on Aug. 25, 2020, 5:08 p.m.