Sim: 'Sim' class generator

In ICTatRTI/PersonAlyticsSim: Package to automate simulation studies for PersonAlyticsPower

Sim class generator

Description

Sim class generator

Sim class generator

Details

Some text here

Methods

print

Active bindings

simName

Charecter. A name for your simulation study.

Methods

Public methods

• Sim$new()

• Sim$print()

• Sim$emptyDirs()

• Sim$start()

• Sim$cleandirs()

• Sim$progress()

• Sim$summary()

• Sim$summarize()

• Sim$glm()

• Sim$plot()

• Sim$clone()

---

Method new()

Usage

Sim$new(
  simName,
  seed,
  B,
  conditions = list(),
  dirNames = list(),
  type = c("param", "nonpar"),
  nodeNames = Sys.info()["nodename"]
)

---

Method print()

Usage

Sim$print(...)

---

Method emptyDirs()

Usage

Sim$emptyDirs()

---

Method start()

Usage

Sim$start(
  ext = "complete",
  run1 = NULL,
  cleanup = TRUE,
  checkOnly = FALSE,
  debug = FALSE,
  ...
)

Arguments

checkOnly

Not implemented, consider deprecating, $progress() works

---

Method cleandirs()

Usage

Sim$cleandirs()

---

Method progress()

Usage

Sim$progress(ext = "complete", ...)

---

Method summary()

Usage

Sim$summary(...)

---

Method summarize()

Usage

Sim$summarize(fpc = TRUE, raw = FALSE, ...)

---

Method glm()

Usage

Sim$glm(
  y,
  interactionOrder = 1,
  alpha = 0.05,
  subset = NULL,
  subsetVarName = NULL,
  recode = NULL,
  ...
)

---

Method plot()

Usage

Sim$plot(
  x,
  y,
  group,
  facet = NULL,
  subset = NULL,
  title = "",
  data = NULL,
  ...
)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Sim$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Stephen Tueller [e-mail]

ICTatRTI/PersonAlyticsSim documentation built on April 23, 2022, 12:48 a.m.