simitation (version 0.0.7)

sim.prop.test: sim.prop.test

Description

sim.prop.test

Usage

sim.prop.test(
  simdat.prop,
  p = NULL,
  alternative = c("two.sided", "less", "greater"),
  conf.level = 0.95,
  correct = TRUE,
  experiment.name = "experiment",
  value.name = "x"
)

Value

A data.table containing test statistics for each experiment based on the one-sample proportions test. Columns typically include experiment name, statistic, p-value, and other relevant metrics as returned by the internal testing function.

Arguments

simdat.prop

Data for use in one-sample proportions tests across one or more experiments. Structure is in the form returned by the function simitation::sim.prop().

p

See help(prop.test).

alternative

See help(prop.test).

conf.level

See help(prop.test).

correct

See help(prop.test).

experiment.name

A character value providing the name of the column identifying the experiment.

value.name

A character value providing the name of the column identifying the values.

Examples

simdat.prop <- sim.prop(n = 30, p = 0.45, num.experiments = 2,
experiment.name = "simulation_id", value.name = "success", seed = 104)

test.statistics.prop <- sim.prop.test(simdat.prop = simdat.prop, p = 0.5,
 alternative = "two.sided", conf.level = 0.99, correct = TRUE,
 experiment.name = "simulation_id", value.name = "success")