simitation (version 0.0.7)

simstudy.t2: simstudy.t2

Description

simstudy.t2

Usage

simstudy.t2(
  nx,
  ny,
  meanx = 0,
  meany = 1,
  sdx = 1,
  sdy = 1,
  num.experiments = 1,
  alternative = c("two.sided", "less", "greater"),
  mu = 0,
  var.equal = FALSE,
  conf.level = 0.95,
  the.quantiles = c(0.025, 0.1, 0.25, 0.5, 0.75, 0.9, 0.975),
  experiment.name = "experiment",
  group.name = "group",
  x.value = "x",
  y.value = "y",
  value.name = "value",
  seed = 3471,
  vstr = 3.6
)

Value

A list containing the following components:

• simdat.t2A data frame of the simulated t-distributed data for two groups.

• test.statistics.t2A data frame containing the results of the t-tests for two groups.

• sim.analysis.t2A data frame containing the analysis of the simulated study for t-tests for two groups.

Arguments

nx

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

ny

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

meanx

A numeric value for the expected value of the x group used in the simulation.

meany

A numeric value for the expected value of the y group used in the simulation.

sdx

A numeric value for the standard deviation of the x group used in the simulation.

sdy

A numeric value for the standard deviation of the y group used in the simulation.

num.experiments

A numeric value representing the number of simulated experiments.

alternative

See help(t.test).

mu

See help(t.test)

var.equal

A logical indicating whether to treat the two variances as being equal. If TRUE, then a pooled variance is used to estimate the variance, otherwise the variances are estimated separately. See help(t.test).

conf.level

See help(t.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.

group.name

A character value providing the name of the column of the group labels.

x.value

A character value specifying the label used for data in the x group (in the column labled by the group.name parameter).

y.value

A character value specifying the label used for data in the y group (in the column labled by the group.name parameter).

value.name

A character value specifying the name of the column that contains the value of the simulated data.

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.t2 <- simstudy.t2(nx = 30, ny = 40,
meanx = 0, meany = 0.2, sdx = 1, sdy = 1, num.experiments = 2,
 alternative = "less", mu = 0, conf.level = 0.9,
 the.quantiles = c(0.1, 0.5, 0.9), experiment.name = "experiment_id",
  group.name = "category", x.value = "a",
  y.value = "b", value.name = "measurement", seed = 41)