inst/doc/parameters.R

## ----setup, include=FALSE-----------------------------------------------------
knitr::opts_chunk$set(echo = TRUE)

## ---- eval=FALSE--------------------------------------------------------------
#  options(EventStudy.URL = "http://api.eventstudytools.com")

## ---- eval=FALSE--------------------------------------------------------------
#  getOption("EventStudy.tryAttempts")

## ---- eval=FALSE--------------------------------------------------------------
#  apiUrl <- "http://api.eventstudytools.com"
#  apiKey <- "Please insert your key here"
#  
#  # Setup API Connection
#  estSetup <- EventStudyAPI$new(apiUrl)
#  estSetup$authentication(apiKey)
#  
#  # Perform Event Study
#  estResults <- estSetup$performEventStudy(estParams     = volatilityEstParams,
#                                           dataFiles     = c("request_file" = "01_RequestFile.csv",
#                                                             "firm_data"    = "02_firmData.csv",
#                                                             "market_data"  = "03_marketData.csv"),
#                                           downloadFiles = T, # download result files
#                                           checkFiles    = T) # check input files

## ---- eval=FALSE--------------------------------------------------------------
#  options(EventStudy.KEY = apiKey)

## ---- eval=FALSE--------------------------------------------------------------
#  returnEstParams <- ARCApplicationInput$new()

## ---- eval=FALSE--------------------------------------------------------------
#  returnEstParams$setResultFileType("xlsx")

## ---- eval=FALSE--------------------------------------------------------------
#  returnEstParams$setReturnType("simple")

## ---- eval=FALSE--------------------------------------------------------------
#  returnEstParams$setNonTradingDays("earlier")

## ---- eval=FALSE--------------------------------------------------------------
#  returnEstParams <- ARCApplicationInput$new()

## ---- eval=FALSE--------------------------------------------------------------
#  returnEstParams$setBenchmarkModel("mm-sw")

## ---- eval=FALSE--------------------------------------------------------------
#  returnEstParams$setTestStatistics(c("aarptlz", "aarrankz"))

## ---- eval=FALSE--------------------------------------------------------------
#  volumeEstParams <- AVCApplicationInput$new()

## ---- eval=FALSE--------------------------------------------------------------
#  volumeEstParams$setBenchmarkModel("mm-sw")

## ---- eval=FALSE--------------------------------------------------------------
#  volumeEstParams$setTestStatistics(c("aarptlz", "aarrankz"))

## ---- eval=FALSE--------------------------------------------------------------
#  volatilityEstParams <- AVyCApplicationInput$new()

## ---- eval=FALSE--------------------------------------------------------------
#  volatilityEstParams$setTestStatistics(c("aarptlz", "aarrankz"))

Try the EventStudy package in your browser

Any scripts or data that you put into this service are public.

EventStudy documentation built on March 31, 2023, 5:43 p.m.