Package index • ezrsurvey

Import data

Load and shape raw survey exports.

parse_filename(): Split a filename column into metadata columns
read_folder(): Read and stack every CSV in a folder
select_prefix(): Select identifier and prefixed columns
select_suffix(): Select identifier and suffixed columns

Clean & recode

Turn messy survey columns into tidy, analysis-ready variables.

add_region(): Add region (and subregion) columns from a country column
bin_numeric(): Bin a numeric vector into labelled groups
clean_label(): Tidy an exported column name into a readable label
drop_items(): Drop unwanted answer categories from a question
ensure_numeric(): Coerce text to numeric, salvaging embedded numbers
generation_scheme(): Generational-cohort definitions
na_blank(): Convert blank and boilerplate non-answers to NA
nps_group(): Classify Net Promoter Score answers into groups
recode_age(): Recode age into standard survey bands
recode_generation(): Recode age or birth year into a generational cohort
recode_likert(): Recode a worded rating scale to integers
recode_region() recode_subregion(): Look up the region or subregion for a country
split_multi(): Split a packed multi-select column into one column per answer

Summarise

Percentages, summaries and cross-tabulations in one line.

calc_percentage(): Count a categorical question as percentages
calc_percentage_batch(): Percentages for a batch of questions at once
calc_percentage_multi(): Tabulate a check-all-that-apply (multi-select) question as percentages
calc_summary(): Summarise a numeric question (mean / median / sd)
clear_checkpoints(): Delete saved cross-tab checkpoints
crosstab(): Cross-tabulate two survey questions
crosstab_banner(): Build a master banner (cross-tab) table

Weighting

Post-stratification / raking applied automatically to the summaries.

clear_weights_cache(): Forget cached survey weights
set_weights(): Set a survey weighting scheme for the session
weight_vector(): Compute the per-respondent survey weights
get_weights() has_weights() clear_weights(): Inspect or clear the session weighting scheme

Model

NPS and importance/performance modelling.

calc_importance(): Driver importance
calc_nps(): Net Promoter Score
ipm_model(): Build an importance / performance model

Compare

Differences between events, waves or segments.

compare_values(): Compare a metric between two datasets (e.g. two events or waves)
plot_diff(): Diverging bar chart of differences

Diagnostics

Sampling precision and standard errors.

diagnose(): Survey precision diagnostics for one or more columns
margin_of_error(): Margin of error from a standard error
precision_summary(): Plain-language survey precision summary
rse(): Relative standard error
rse_rating(): Rate precision from a relative standard error
se_mean(): Standard error of a mean (point estimate)
se_prop(): Standard error of a proportion

Comments

Select illustrative open-text comments.

sample_comments(): Pick a random sample of open-text comments
sample_comments_diverse(): Pick a diverse, information-rich sample of comments

Currency

Convert monetary amounts between currencies.

add_currency(): Add a converted-currency column to a data frame
convert_currency(): Convert amounts between currencies
list_currencies(): List the currencies in a rate table

Plots

Presentation-ready charts.

plot_bars(): Bar chart of a percentage table (auto-laid-out)
plot_gauges(): Stacked score gauges (NPS over average quality, etc.)
plot_ipm(): Importance / performance matrix
plot_nps(): NPS distribution slide (0-10 scale with group labels)
plot_nps_gauge(): Score gauge with decision bands and a value marker
plot_quotes_tree(): Treemap of selected quotes
plot_rating_grid(): A stacked rating chart for a whole block of questions
plot_stacked_rating(): Stacked rating bars with weighted-average ordering

Brand

Adopt an organisation’s colours and typefaces for every chart.

brand_info(): Show the active brand settings
clear_brand(): Clear the active brand
pal_brand(): Brand colour palette
scale_fill_brand() scale_colour_brand() scale_color_brand(): Brand fill and colour scales
use_brand(): Adopt an organisation brand from a PowerPoint or Word template

Themes, palettes & decisions

Visual identity and decision-band annotations.

pal_rating pal_nps pal_sequential_blue pal_neutral: ezrsurvey colour palettes
scale_fill_nps(): NPS group fill scale
scale_fill_rating() scale_colour_rating() scale_color_rating(): Rating colour and fill scales
theme_ezrsurvey() theme_ezrsurvey_x() theme_ezrsurvey_y() theme_ezrsurvey_xy(): ezrsurvey ggplot2 themes
theme_transparent(): Transparent-background theme fragment
annotate_bands(): Annotate a plot with labelled decision bands
bands_rating_3() bands_rating_5() bands_nps() bands_nps_score(): Built-in decision-band presets
mark_value(): Mark a single value on a plot
rescale_bands(): Move a band specification onto another scale
label_pct(): Percent label formatter
nice_max(): Round an axis maximum up to a "nice" value
scale_y_pct(): Continuous y-scale capped at a nice maximum with optional percent labels

Save & report

Export tables, charts, decks and Quarto reports.

export_summary_xlsx(): Export a per-question summary workbook (table + chart per sheet)
export_xlsx(): Export several tables to one Excel workbook, a tab each
save_data(): Quick-save a table to CSV, TSV or XLSX
save_output(): Quick-save any ezrsurvey output (plot or table)
save_plot(): Quick-save a plot to PNG, SVG or PDF
example_report(): Copy the worked example report into a folder
list_report_templates(): Available Quarto report templates
report_add_plot(): Add a plot to a report
report_add_slide(): Add a slide (PowerPoint) or heading (Word) to a report
report_add_table(): Add a table to a report
report_add_text(): Add a paragraph of text to a report
report_deck(): Build a slide deck from a list of plots and tables in one call
report_layouts(): List the slide layouts of a PowerPoint template
report_new(): Start a new PowerPoint or Word report
report_save(): Save a report to disk
report_section(): Add a section-divider slide
report_slide(): Add a whole slide in one call (title plus its content)
report_title_slide(): Add the opening title slide
scaffold_report(): Scaffold a Quarto survey-report template

Configuration

Options, reusable orders and profiles.

apply_order(): Apply a registered order to a vector
get_dataset() has_dataset() clear_dataset() dataset_vars(): Get, check or clear the default dataset
edit_ezrsurvey_profile(): Open the ezrsurvey profile for editing
ezrsurvey_options(): Get or set ezrsurvey defaults
ezrsurvey_profile_paths(): Profile file locations ezrsurvey looks in
get_order(): Get the levels of a registered order
list_orders(): List registered orders
load_ezrsurvey_profile(): Load ezrsurvey defaults from a YAML profile
order_for(): Find the order that applies to a variable
register_order(): Register a reusable ordinal level order
register_order_presets(): Register a set of common ordinal scales
remove_order(): Remove a registered order
reset_ezrsurvey_options(): Reset all ezrsurvey options to their built-in defaults
save_ezrsurvey_profile(): Save current options and orders to a profile
use_dataset(): Set a default dataset for the session
use_ezrsurvey_profile(): Create a starter ezrsurvey profile

Datasets

country_region: Country to region lookup
currency_rates: Currency exchange-rate snapshot
podracing_survey: Simulated pod-racing fan survey
shopping_survey: Simulated historical shopping-behaviour survey