ApplicationInputInterface: Abstract Application Input Interface for Event Study R...

In EventStudyTools/api-wrapper.r: Event Study Analysis

Abstract Application Input Interface for Event Study R Package

Description

Abstract class no description.

Format

R6Class object.

Methods

$new()

Constructor for ApplicationInputInterface. This class should not used directly.

$setNamedList()

Function to setup hierarchical lists.

$serialize()

Seriealize a R6-Object.

$serializeToJson(level)

Seriealize a R6-Object as a JSON-Object.

Arguments

type

Set the result file type.

level

Level to seriealize.

Public fields

parameters

Parameters

result_file_type

Result file type.

Methods

Public methods

• ApplicationInputInterface$setResultFileType()

• ApplicationInputInterface$setNamedList()

• ApplicationInputInterface$serializeToJson()

• ApplicationInputInterface$serialize()

• ApplicationInputInterface$clone()

---

Method setResultFileType()

Set result file type

Usage

ApplicationInputInterface$setResultFileType(type = "csv")

Arguments

type

Possible are csv, xls, xlsx, ods

---

Method setNamedList()

Function to setup hierarchical lists. For internal usage.

Usage

ApplicationInputInterface$setNamedList(
  parentLevel,
  secondLevel = NULL,
  thirthLevel = NULL,
  parameterList
)

Arguments

parentLevel

parent level

secondLevel

parent level

thirthLevel

parent level

parameterList

parent level

---

Method serializeToJson()

Serialize a list to json. For internal use.

Usage

ApplicationInputInterface$serializeToJson(level = NULL)

Arguments

level

The level that should be serialized.

---

Method serialize()

Serialize. For internal use.

Usage

ApplicationInputInterface$serialize()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ApplicationInputInterface$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

EventStudyTools/api-wrapper.r documentation built on April 16, 2023, 1:04 p.m.