estimate_reliability: Estimate coverage reliability

View source: R/estimate_reliability.R

estimate_reliabilityR Documentation

Estimate coverage reliability

Description

Given proximity range and sample size, estimate coverage reliability using Monte Carlo simulation.

Usage

estimate_reliability(
  n,
  k,
  prox_lo,
  prox_hi,
  n_sim = 1e+05,
  seed = NULL,
  save_data = FALSE
)

Arguments

n

Sample size.

k

Number of standard deviations from the mean to be used to calculate interval.

prox_lo

Lower proximity limit expressed as a proportion on the closed interval between 0 and 1.

prox_hi

Upper proximity limit expressed as a proportion on the closed interval between 0 and 1.

n_sim

Number of simulation iterations to generate coverage sampling distribution.

seed

Randomization seed.

save_data

If TRUE, return vector of coverage calculations for simulated samples.

Value

Estimated reliability (reliability_hat) conditional on proximity limits. If save_data is TRUE, return a list with reliability_hat and vector of simulated sample coverage values.

Examples

estimate_reliability(
  n = 20,
  k = 2,
  prox_lo = 0.93,
  prox_hi = 0.97
)

dygobeng/nterval documentation built on March 22, 2022, 6:40 p.m.