Overview
This vignette describes various scenarios of creating sample datasets
that fit the preferences and needs of the users; and this for the
different models. The functions in the package PINstimation use two
types of datasets: (1) A sequence of daily buys and sells (2) A
high-frequency trading data. This is the reason why only two sample
datasets are preloaded with the package, namely
dailytrades, and hfdata. The users can also
generate simulation data using the function
generatedata_mpin() for PIN, and MPIN models; and the
function generatedata_adjpin() for the ADJPIN model. Below
we provide some scenarios of creating sample datasets both for the PIN,
MPIN, and ADJPIN models.
Sample datasets for the PIN model
The PIN model is an multilayer PIN model with a single information
layer. We can, therefore, use the function
generatedata_mpin(), in order to generate sample data for
the PIN model. Generically, this is done as follows:
generatedata_mpin(..., layers=1)If the user would like to create a sample dataset for infrequently
traded stock, she can specify low values or ranges for the trade
intensity rates. For instance, let’s assume that the user suspects that
an infrequently-traded stock has an average of uninformed trading
intensity for buys and sells between 300 and
500. They generate a single sample dataset for this
scenario as follows:
pindata <- generatedata_mpin(layers=1, ranges = list(eps.b=c(300, 500), eps.s=c(300,500)), verbose = FALSE)The details of the generated sample dataset can be displayed with the following code
show(pindata)## ----------------------------------
## Data series successfully generated
## ----------------------------------
## Simulation model : MPIN model
## Number of layers : 1 layer(s)
## Number of trading days : 60 days
## ----------------------------------
## Type object@data to get the simulated data
##
## Data simulation
##
## =========== ============== ============ =============
## Variables Theoretical. Empirical. Aggregates.
## =========== ============== ============ =============
## alpha 0.75074 0.8 0.8
## delta 0.930447 0.916667 0.916667
## mu 191 185.93 185.93
## eps.b 405 404.54 404.54
## eps.s 340 343.5 343.5
## ----
## Likelihood - (572.801) (572.801)
## mpin - 0.165868 0.165868
## =========== ============== ============ =============
##
## -------
## Running time: 0.007 secondsYou access the sequences of buys, and sells through the slot
@data of the object pindata.
show(pindata@data[1:10, ])## b s
## 1 391 346
## 2 398 537
## 3 390 511
## 4 605 343
## 5 411 562
## 6 410 540
## 7 378 559
## 8 370 538
## 9 442 529
## 10 451 524You can, now use the dataset object pindata to check the
accuracy of the different estimation functions. You can do that by
comparing the actual parameters of the sample datasets to the estimated
parameters of the estimation functions. Let us start with displaying the
actual parameters of the sample datasets. These can be accessed through
the slot @empiricals of the dataset object, which stores
the empirical parameters computed from the sequences of buys and sells
generated. Please refer to the documentation of
generatedata_mpin() for more information.
actual <- unlist(pindata@empiricals)
show(actual)## alpha delta mu eps.b eps.s
## 0.8000000 0.9166667 185.9345238 404.5357143 343.5000000Estimate the PIN model using the function pin_ea(), and
display the estimated parameters
model <- pin_ea(data=pindata@data, verbose = FALSE)
estimates <- model@parameters
show(estimates)## alpha delta mu eps.b eps.s
## 0.7999988 0.9166662 184.6889429 404.0345122 344.9976254Now calculate the absolute errors of the estimation method.
errors <- abs(actual - estimates)
show(errors)## alpha delta mu eps.b eps.s
## 1.240666e-06 4.708938e-07 1.245581e+00 5.012020e-01 1.497625e+00Sample datasets for the MPIN model
In contrast to the PIN model, the number of information layers is
free. We can, therefore, use the function
generatedata_mpin() with the desired number of information
layers, in order to generate sample data for the MPIN model. We can also
skip specifying the number of layers, and the default setting will be
used: the number of layers will be randomly selected from the integer
set from 1 to 5. Generically, this is done as
follows:
generatedata_mpin(...)If the user would like to create a sample dataset for frequently
traded stock with two information layers, she can set the argument
layers to 2, and specify high values or ranges for the trade intensity
rates. For instance, let’s assume that the user suspects that a
frequently-traded stock has an average of uninformed trading intensity
for buys and sells between 12000 and 15000.
They generate a single sample dataset for this scenario as follows:
mpindata <- generatedata_mpin(layers=2, ranges = list(eps.b=c(12000, 15000), eps.s=c(12000,15000)), verbose = FALSE)The details of the generated sample dataset can be displayed with the following code
show(mpindata)## ----------------------------------
## Data series successfully generated
## ----------------------------------
## Simulation model : MPIN model
## Number of layers : 2 layer(s)
## Number of trading days : 60 days
## ----------------------------------
## Type object@data to get the simulated data
##
## Data simulation
##
## =========== ================== ================== =============
## Variables Theoretical. Empirical. Aggregates.
## =========== ================== ================== =============
## alpha 0.408734, 0.176757 0.266667, 0.200000 0.466667
## delta 0.329540, 0.106907 0.25, 0.25 0.25
## mu 1282, 2852 1225.26, 2758.47 1882.35
## eps.b 13377 13411.46 13411.46
## eps.s 12285 12268.06 12268.06
## ----
## Likelihood - (828.342) (828.342)
## mpin - 0.033076 0.033076
## =========== ================== ================== =============
##
## -------
## Running time: 0.004 secondsYou access the sequences of buys, and sells through the slot
@data of the object pindata.
show(mpindata@data[1:10, ])## b s
## 1 13275 12341
## 2 13378 13298
## 3 13288 12387
## 4 14914 12240
## 5 13323 12246
## 6 13232 12217
## 7 14755 12344
## 8 13442 12196
## 9 16269 12263
## 10 13586 12284You can, now use the dataset object mpindata to check
the accuracy of the different estimation functions, namely
mpin_ml(), and mpin_ecm(). You can do that by
comparing the empirical PIN value derived from the sample dataset to the
estimated PIN value of the estimation functions. Let us start with
displaying the empirical PIN value obtained from the sample dataset.
This value can be accessed through the slot @emp.pin of the
dataset object, which stores the empirical PIN value computed from the
sequences of buys and sells generated. Please refer to the documentation
of generatedata_mpin() for more information.
actualmpin <- unlist(mpindata@emp.pin)
show(actualmpin)## MPIN
## 0.03307604Estimate the MPIN model using the functions mpin_ml(),
and mpin_ecm, and display the estimated MPIN values.
model_ml <- mpin_ml(data=mpindata@data, verbose = FALSE)
model_ecm <- mpin_ecm(data=mpindata@data, verbose = FALSE)
mlmpin <- model_ml@mpin
ecmpin <- model_ecm@mpin
estimates <- setNames(c(mlmpin, ecmpin), c("ML", "ECM"))
show(estimates)## ML ECM
## 0.03307597 0.03307748Now calculate the absolute errors of both estimation methods.
errors <- abs(actualmpin - estimates)
show(errors)## ML ECM
## 7.001822e-08 1.436217e-06The function generatedata_mpin() can generate a
data.series object that contains a collection of
dataset objects. For instance, the user can generate a
collection of 10 datasets, whose data sequences span 60 days, and
contain 3 layers, and use it to check the accuracy of the MPIN
estimation.
size <- 10
collection <- generatedata_mpin(series = size, layers = 3, verbose = FALSE)
show(collection)## ----------------------------------
## Simulated data successfully generated
## ----------------------------------
## Simulation model : MPIN model
## Number of layers : 3 layer(s)
## Number of datasets : 10 datasets
## Number of trading days : 60 days
## ----------------------------------
## Type object@datasets to access the list of dataset objects
##
## Data simulation
##
## -------
## Running time: 0.042 seconds
accuracy <- devmpin <- 0
for (i in 1:size) {
sdata <- collection@datasets[[i]]
model <- mpin_ml(sdata@data, xtraclusters = 3, verbose=FALSE)
accuracy <- accuracy + (sdata@layers == model@layers)
devmpin <- devmpin + abs(sdata@emp.pin - model@mpin)
}
cat('The accuracy of layer detection: ', paste0(accuracy*(100/size),"%.\n"), sep="")## The accuracy of layer detection: 90%.
cat('The average error in MPIN estimates: ', devmpin/size, ".\n", sep="")## The average error in MPIN estimates: 0.003185484.Sample datasets for the ADJPIN model
The AdjPIN model is an extension of the PIN model that includes the
possibility of liquidity shocks. To obtain a sample dataset distributed
according to the assumptions of the AdjPIN model, users can use the
function generatedata_adjpin(). Generically, this is done
as follows:
generatedata_adjpin(...)If the user desires to create 10 sample datasets for frequently
traded stock, they can specify high values or ranges for the trade
intensity rates. For instance, let’s assume that the user suspects that
a frequently-traded stock has an average of uninformed trading intensity
for buys and sells between 10000 and
15000.
adjpindatasets <- generatedata_adjpin(series = 10, ranges = list(eps.b=c(10000, 15000), eps.s=c(10000,15000)), verbose = FALSE)The details of the generated sample data series can be displayed with the following code:
show(adjpindatasets)## ----------------------------------
## Simulated data successfully generated
## ----------------------------------
## Simulation model : AdjPIN model
## Model Restrictions : Unrestricted model
## Number of datasets : 10 datasets
## Number of trading days : 60 days
## ----------------------------------
## Type object@datasets to access the list of dataset objects
##
## Data simulation
##
## -------
## Running time: 0.126 secondsYou access the first dataset from adjpindata using this
code:
adjpindata <- adjpindatasets@datasets[[1]]
show(adjpindata)## ----------------------------------
## Data series successfully generated
## ----------------------------------
## Simulation model : AdjPIN model
## Model Restrictions : Unrestricted model
## Number of trading days : 60 days
## ----------------------------------
## Type object@data to get the simulated data
##
## Data simulation
##
## =========== ============== ============
## Variables Theoretical. Empirical.
## =========== ============== ============
## alpha 0.482618 0.483333
## delta 0.971041 0.965517
## theta 0.556324 0.419355
## theta' 0.230787 0.172414
## ----
## eps.b 10372 10379.3
## eps.s 13915 13954
## mu.b 21159 21200.37
## mu.s 22512 22643.34
## d.b 18879 18823.34
## d.s 18280 18224.66
## ----
## Likelihood (841.801)
## adjPIN 0.217 0.236
## PSOS 0.297 0.24
## =========== ============== ============
##
## -------
## Running time: 0.01 secondsYou can, now use the dataset object adjpindata to check
the accuracy of the different estimation functions, namely MLE, and ECM
algorithms. You can do that by comparing the empirical adjpin, and psos
values derived from the sample dataset to the estimated adjpin, and psos
values obtained from the estimation functions. Let us start with
displaying the empirical adjpin, and psos values obtained from the
sample dataset. These values can be accessed through the slot
@emp.pin of the dataset object, which stores the empirical
adjpin/psos value computed from the sequences of buys and sells
generated. Please refer to the documentation of
generatedata_adjpin() for more information.
actualpins <- unlist(adjpindata@emp.pin)
show(actualpins)## adjpin psos
## 0.2355126 0.2397001Estimate the AdjPIN model using adjpin(method="ML"), and
adjpin(method="ECM", and display the estimated adjpin/psos
values.
model_ml <- adjpin(data=adjpindata@data, method = "ML", verbose = FALSE)
model_ecm <- adjpin(data=adjpindata@data, method = "ECM", verbose = FALSE)
mlpins <- c(model_ml@adjpin, model_ml@psos)
ecmpins <- c(model_ecm@adjpin, model_ecm@psos)
estimates <- rbind(mlpins, ecmpins)
colnames(estimates) <- c("adjpin", "psos")
rownames(estimates) <- c("ML", "ECM")
show(estimates)## adjpin psos
## ML 0.2347848 0.2401366
## ECM 0.2347805 0.2401286Now calculate the absolute errors of both estimation methods.
## adjpin psos
## ML 0.0007278246 0.0004365147
## ECM 0.0007321610 0.0004284736Getting help
If you encounter a clear bug, please file an issue with a minimal reproducible example on GitHub.