make_overall_plot: CES overall plot

Description Usage Arguments Value

View source: R/overall_df_plots.R

Description

A function to make the overrall plot for dashboards with the make_overall_plot_df output.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
make_overall_plot(
  overall_plot_df,
  target = 0.75,
  target_text = "WHO\nminimum target",
  theme_object = NA,
  y_axis_label_reach = "Programme Reach & 95% CI (in %)\n",
  y_axis_label_coverage = "Survey Coverage & 95% CI (in %)\n",
  x_axis_label = "\nImplementation Unit",
  survey_point_shape = 16,
  survey_point_size = 4,
  reported_point_shape = 42,
  reported_point_size = 9,
  reported_text = "Reported coverage"
)

Arguments

overall_plot_df

Output from the make_overall_plot_df

target

A numeric value between 0 and 1 to set the WHO target coverage. Default is 0.75.

target_text

A string denoting the text that describes the target. Default is WHO\nminimun target. Note the \n serves to make a new line in the legend text (see output).

theme_object

A ggplot theme object (e.g. theme_classic()) for the plots. Defaults is NA. In that case, the function calls make_sci_theme() to create the default theme. See that function for theme details.

y_axis_label_reach

Y axis label for programme reach. Default is Programme Reach & 95% CI (in %)\n. Note the \n is included to create a blank line underneath to make space. Same for other axis labels.

y_axis_label_coverage

Y axis label for survey coverage. Default is Survey Coverage & 95% CI (in %)\n.

x_axis_label

X axis label denoting the partitions. Default is Implementation Unit

survey_point_shape

Shape of the survey data point. Default is a filled dot (16).

survey_point_size

Size of the survey data point. Default is 4.

reported_point_shape

Shape of the reported coverage data point. Default is a 5 arms star (42).

reported_point_size

Size of the reported coverage data point. Default is 9.

reported_text

String describing the dots for reported coverage. Default is English: Reported coverage.

Value

A list of plots. Run names(make_overall_plot output) to see them. Call them individually by using {make_overall_plot output}[[{name of the particular plot}]].


gronert-m/sciCoverageR documentation built on Nov. 23, 2020, 10:33 p.m.