simitation (version 0.0.7)

simstudy.prop: simstudy.prop

Description

simstudy.prop

Usage

simstudy.prop(
  n,
  p.actual = 0.5,
  p.hypothesized = 0.5,
  num.experiments = 1,
  alternative = c("two.sided", "less", "greater"),
  conf.level = 0.95,
  correct = TRUE,
  the.quantiles = c(0.025, 0.1, 0.25, 0.5, 0.75, 0.9, 0.975),
  experiment.name = "experiment",
  value.name = "x",
  seed = 7261,
  vstr = 3.6
)

Value

A list containing the following components:

• simdat.propA data frame of the simulated proportions.

• test.statistics.propA data frame containing the results of the proportion tests.

• sim.analysis.propA data frame containing the analysis of the simulated study for proportions.

Arguments

n

A numeric value for the number of observations in each experiment.

p.actual

A numeric value for the actual probability of success.

p.hypothesized

A numeric value for the hypothesized probability of success.

num.experiments

A numeric value representing the number of simulated experiments.

alternative

See help(prop.test).

conf.level

See help(prop.test).

correct

See help(prop.test).

the.quantiles

A numeric vector of values between 0 and 1. Summary statistics to analyze the tests will return the specified quantiles.

experiment.name

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

value.name

A character value providing the name for the simulated values.

seed

A single numeric value, interpreted as an integer, or NULL. See help(set.seed).

vstr

A character string containing a version number, e.g., "1.6.2". The default RNG configuration of the current R version is used if vstr is greater than the current version. See help(set.seed).

Examples

study.prop <- simstudy.prop(n = 30, p.actual = 0.42,
p.hypothesized = 0.5, num.experiments = 2, alternative = "less",
 conf.level = 0.92, correct = TRUE, the.quantiles = c(0.04, 0.5, 0.96),
 experiment.name = "simulation_id", value.name = "success", seed = 8001)