experiences (version 0.1.1)

compare_benchmark_event: Compare Probability of an Event with Benchmark

Description

Compare Probability of an Event with Benchmark

Usage

compare_benchmark_event(
  benchmark,
  event,
  total,
  event_type = "",
  notes = c("minimal", "technical")
)

Value

list of event rate, probability, notes

Arguments

benchmark

benchmark

event

event

total

total

event_type

Optional: a string describing the type of event. For example, success, failure, etc.

notes

whether output should contain minimal, technical, or executive type of notes.

Examples

compare_benchmark_event(benchmark = 0.7,
                     event = 10,
                     total = 12,
                     event_type = "success",
                     notes = "minimal")