EcologicalInferenceProcessor: EcologicalInferenceProcessor

In rOpenStats/ElectionsLATAM: Statistics Methods for Applying in LATAM Elections

EcologicalInferenceProcessor

Description

EcologicalInferenceProcessor

EcologicalInferenceProcessor

Methods

Public methods

• EcologicalInferenceProcessor$new()

• EcologicalInferenceProcessor$wallTime()

• EcologicalInferenceProcessor$generateOutput()

• EcologicalInferenceProcessor$loadInputPivotCandidatos()

• EcologicalInferenceProcessor$generateNormalizedOutput()

• EcologicalInferenceProcessor$makeSankeyDiagram()

• EcologicalInferenceProcessor$getFilename()

• EcologicalInferenceProcessor$generateOutputJSON()

• EcologicalInferenceProcessor$getBetab()

• EcologicalInferenceProcessor$exportBetab()

• EcologicalInferenceProcessor$convertShares2Votes()

• EcologicalInferenceProcessor$convertVotes2Shares()

• EcologicalInferenceProcessor$getSharesFields()

• EcologicalInferenceProcessor$fixLocationsAvailable()

• EcologicalInferenceProcessor$fixEmpty()

• EcologicalInferenceProcessor$checkDefinitions()

• EcologicalInferenceProcessor$runScenario()

• EcologicalInferenceProcessor$showResultsSummary()

• EcologicalInferenceProcessor$expectCompatible()

• EcologicalInferenceProcessor$clone()

---

Method new()

Usage

EcologicalInferenceProcessor$new(
  election.name,
  ecological.inference.strategy,
  data.input.path,
  input.filename,
  scenario,
  location.fields,
  votes.field,
  absent.field = "ausente",
  parties.mapping = NULL,
  reverse.mapping = TRUE,
  potential.votes.field = NULL,
  ignore.fields = NULL,
  col.types = cols(.default = col_number()),
  seed = 143324
)

---

Method wallTime()

Usage

EcologicalInferenceProcessor$wallTime(expr)

---

Method generateOutput()

Usage

EcologicalInferenceProcessor$generateOutput()

---

Method loadInputPivotCandidatos()

Usage

EcologicalInferenceProcessor$loadInputPivotCandidatos(
  input.filename = self$input.filename
)

---

Method generateNormalizedOutput()

Usage

EcologicalInferenceProcessor$generateNormalizedOutput(indicator = "perc")

---

Method makeSankeyDiagram()

Usage

EcologicalInferenceProcessor$makeSankeyDiagram(output.path = NULL)

---

Method getFilename()

Usage

EcologicalInferenceProcessor$getFilename(file.prefix, extension = "csv")

---

Method generateOutputJSON()

Usage

EcologicalInferenceProcessor$generateOutputJSON(
  output.path = NULL,
  filename = self$getFilename(paste(self$election.name, "-ein", sep = ""), extension =
    "json")
)

---

Method getBetab()

Usage

EcologicalInferenceProcessor$getBetab()

---

Method exportBetab()

Usage

EcologicalInferenceProcessor$exportBetab(
  output.folder = NULL,
  overwrite = FALSE
)

---

Method convertShares2Votes()

Usage

EcologicalInferenceProcessor$convertShares2Votes(election.df)

---

Method convertVotes2Shares()

Usage

EcologicalInferenceProcessor$convertVotes2Shares(election.df)

---

Method getSharesFields()

Usage

EcologicalInferenceProcessor$getSharesFields(election.fields)

---

Method fixLocationsAvailable()

Usage

EcologicalInferenceProcessor$fixLocationsAvailable(
  max.potential.votes.rel.dif = Inf
)

---

Method fixEmpty()

Usage

EcologicalInferenceProcessor$fixEmpty()

---

Method checkDefinitions()

Usage

EcologicalInferenceProcessor$checkDefinitions()

---

Method runScenario()

Usage

EcologicalInferenceProcessor$runScenario(
  include.blancos = TRUE,
  include.ausentes = TRUE,
  max.potential.votes.rel.dif = Inf
)

---

Method showResultsSummary()

Usage

EcologicalInferenceProcessor$showResultsSummary(election.df, description)

---

Method expectCompatible()

Usage

EcologicalInferenceProcessor$expectCompatible(
  output.table.expected,
  tolerance.rel = 0.1
)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

EcologicalInferenceProcessor$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

ken4rab

Examples

library(ElectionsLATAM)
library(readr)
costa.rica.ein.path <- file.path(getPackageDir(), "costa-rica")
ecological.inference.calvo <- EcologicalInferenceStrategyCalvoEtAl$new()
costa.rica.ein <-
  EcologicalInferenceProcessor$new(
    ecological.inference.strategy = ecological.inference.calvo,
    election.name = "2022-costa-rica-general-ballotage-n4",
    scenario = "final",
    data.input.path = costa.rica.ein.path,
    input.file = "2021-generales_pivot_candidatos_n4.csv",
    location.fields = c("id_unidad"),
    votes.field = "votos",
    # potential.votes.field = "habilitados",
    ignore.fields = "habilitados",
    col.types = cols(
      .default = col_number(),
      id_unidad = col_character()
    )
  )
dummy <- costa.rica.ein$loadInputPivotCandidatos()
costa.rica.ein$output.election <- readr::read_delim(
  file.path(
    costa.rica.ein.path,
    paste("2022-ballotage_pivot_candidatos_n4.csv", sep = "_")
  ),
  delim = ";",
  col_types = cols(
    .default = col_double(),
    id_unidad = col_character()
  )
)
costa.rica.ein$runScenario(include.blancos = TRUE, include.ausentes = TRUE)

rOpenStats/ElectionsLATAM documentation built on April 22, 2022, 12:53 a.m.