interpretation_result function

Interpretation result

A class to define the result that is returned by an interpretation conducted by confinterpret.

interpretation_result(interpretation, ci, interpretation_set,
  interpretation_set_name = deparse(substitute(interpretation_set)),
  boundaries, comparison_labels, low_to_high)

Arguments

• interpretation: A list object from a an interpretation_set providing the qualitative interpretation.
• ci: The confidence interval that was interpreted.
• interpretation_set: The interpretation_set object that was used to conduct the interpretation.
• interpretation_set_name: The name of the interpretation_set that was used for the interpretation.
• boundaries: The boundaries parameter that was used for the interpretation.
• comparison_labels: Labels that were used to describe the groups that were compared in the interpretation.
• low_to_high: Whether the boundaries were provided in low-to-high or high-to-low order.

Returns

A list object of class interpretation_result with elements stating the interpretation in different formats ($interpretation_short, $interpretation, and $interpretation_md) and $parameters. $parameters is list object detailing the parameters that were used to generate the interpretation, and contains $ci, $interpretation_set, $interpretation_set_name, $boundaries, $comparison_labels and $low_to_high.

Details

The parameters are the ones that were used in conducting the interpretation (typically using confinterpret or one of its convenience wrapper functions). See confinterpret for more details on how these parameters were used in conducting the interpretation.