PoolSurvey Class

This class represents a collection of surveys grouped by specific periods (e.g., monthly, quarterly, annual). It provides methods to access and manipulate the grouped surveys.

Value

An object of class PoolSurvey.

See also

Other panel-surveys: RotativePanelSurvey, extract_surveys(), get_follow_up(), get_implantation()

Public fields

surveys

A list containing the grouped surveys.

Methods

Public methods

• PoolSurvey$new()

• PoolSurvey$get_surveys()

• PoolSurvey$print()

• PoolSurvey$clone()

---

Method new()

Initializes a new instance of the PoolSurvey class.

Usage

PoolSurvey$new(surveys)

Arguments

surveys

A list containing the grouped surveys.

---

Method get_surveys()

Retrieves surveys for a specific period.

Usage

PoolSurvey$get_surveys(period = NULL)

Arguments

period

A string specifying the period to retrieve (e.g., "monthly", "quarterly").

Returns

A list of surveys for the specified period.

---

Method print()

Prints metadata about the PoolSurvey object.

Usage

PoolSurvey$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PoolSurvey$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

s1 <- Survey$new(
  data = data.table::data.table(id = 1:3, w = 1),
  edition = "2023", type = "test", psu = NULL,
  engine = "data.table", weight = add_weight(annual = "w")
)
s2 <- Survey$new(
  data = data.table::data.table(id = 4:6, w = 1),
  edition = "2023", type = "test", psu = NULL,
  engine = "data.table", weight = add_weight(annual = "w")
)
pool <- PoolSurvey$new(list(annual = list("group1" = list(s1, s2))))