Skip to contents

Returns a summary of a IRR simulation.

Source: R/summary.IRRsim.R
summary.IRRsim.Rd

This function will provide predicted IRR statistics for various percent agreements. There are two elements in the returned list: `model` and `summary`. The former are the results of the modeling function and the latter is a data.frame providing the predicted values for various percent agreements. If `stat = 'all'` is specified, the summary table contains the predicted values. If a specific IRR statistic is specified, the summary table contains the predicted value along with the interval.

Usage

# S3 method for IRRsim
summary(
  object,
  method = "loess",
  agreements = seq(0.1, 0.9, by = 0.1),
  stat,
  k,
  predict.interval = "confidence",
  ...
)

Arguments

object

the result of IRRsim::simulateIRR().

method

the method used to find predicted values. Possible values are loess, linear, and quadratic.

agreements

vector of percent agreements to include in the summary table.

stat

the IRR statistic to return summary for, or missing for all metrics.

k

which number of raters to print summary of.

predict.interval

Type of interval calculation. Can be none, confidence, . or prediction.

...

currently unused.

Value

list with summary statistics from [IRRsim::IRRsim()].