Function reference • cascade

Cascade functions

batch_cascade_plot(): Batch cascade plot Returns a plot for all cascades generated by the package. A quick way to produce all permutations of cascade plots. User passes an msd data frame and plots are returned for USAID only for all cascades.

batch_plot(): Batch plot Helped function that is used in the batch_cascade_plot. Takes a data frame, cascade number, plot file type, and image path. Returns a ggplot2 object.

return_cascade(): Returns a munged data frame of cascade data.

return_cascade_plot(): Create plot of selected cascades

plot_cascade(): Plot Cascade plot_cascade is a ggplot2-based plot that arranges, annotates and plots data from the 90-90-90 cascade. Four inputs are required to create a valid plot.

Helper functions

assign_cscd_colors(): Assign cascade colors

assign_mods_colors(): Assign index cascade colors (WIP)

bind_tx_curr_lag(): Title

create_annotations(): Create Plot Annotations

check_metadata(): Check for metadata list

check_plot_entry(): Check plot entry value Validate plot entry from user

fltr_ayp(): Filter for Adults and Young People

fltr_cascade(): Cascade filter Filters the cascade variables to current fiscal year

fltr_disag(): Filter disaggregate

fltr_sex(): Filter sex

font_annot: annotation font family

font_fam: base font family

lag_tx_curr(): Create TX_CURR_Lag2 Filters the cascade variables to current fiscal year

plot_name: Name of cascade plots available to the user

plot_title(): Create cascade plot title

results_color: font color for results

sum_reshape(): Aggregate targets and results

targets_color: targets fill color

youth_wrapper(): Wrapper for youth cascade

Cascade data

disag_kp: List of disaggregate filters needed for KP

disag_mods: List of disaggregate filters needed for modalities for index testing

disag_peds: List of disaggregate filters needed for peds / TN cascades

keep_ind: Name of annotation indicators to include on plots