| pin_yz | R Documentation |
Estimates the Probability of Informed Trading (PIN) using the
initial parameter sets generated using the grid search algorithm of
Yan and Zhang (2012).
pin_yz(data, factorization, ea_correction = FALSE, grid_size = 5,
verbose = TRUE)
data |
A dataframe with 2 variables: the first corresponds to buyer-initiated trades (buys), and the second corresponds to seller-initiated trades (sells). |
factorization |
A character string from
|
ea_correction |
A binary variable determining whether the
modifications of the algorithm of \insertCiteYan2012;textualPINstimation
suggested by \insertCiteErsanAlici2016;textualPINstimation are
implemented. The default value is |
grid_size |
An integer between |
verbose |
A binary variable that determines whether detailed
information about the steps of the estimation of the PIN model is displayed.
No output is produced when |
The argument 'data' should be a numeric dataframe, and contain
at least two variables. Only the first two variables will be considered:
The first variable is assumed to correspond to the total number of
buyer-initiated trades, while the second variable is assumed to
correspond to the total number of seller-initiated trades. Each row or
observation correspond to a trading day. NA values will be ignored.
The factorization variable takes one of four values:
"EHO" refers to the factorization in
\insertCiteEasley2010;textualPINstimation
"LK" refers to the factorization in
\insertCiteWilliamLin2011;textualPINstimation
"E" refers to the factorization in
\insertCiteErsan2016;textualPINstimation
"NONE" refers to the original likelihood function - with no
factorization
The argument grid_size determines the size of the grid of the variables:
alpha, delta, and eps.b. If grid_size is set to a given value m,
the algorithm creates a sequence starting from 1/2m, and ending in
1 - 1/2m, with a step of 1/m. The default value of 5 corresponds
to the size of the grid in \insertCiteYan2012;textualPINstimation.
In that case, the sequence starts at 0.1 = 1/(2 x 5), and ends in
0.9 = 1 - 1/(2 x 5) with a step of 0.2 = 1/m.
The function pin_yz() implements, by default, the original
\insertCiteYan2012;textualPINstimation algorithm as the default value of
ea_correction takes the value FALSE.
When the value of ea_correction is set to TRUE; then, sets
with irrelevant mu values are excluded, and sets with boundary values are
reintegrated in the initial parameter sets.
Returns an object of class estimate.pin
# There is a preloaded quarterly dataset called 'dailytrades' with 60
# observations. Each observation corresponds to a day and contains the
# total number of buyer-initiated trades ('B') and seller-initiated
# trades ('S') on that day. To know more, type ?dailytrades
xdata <- dailytrades
# Estimate the PIN model using the factorization of Lin and Ke(2011), and
# initial parameter sets generated using the algorithm of Yan & Zhang (2012).
# In contrast to the original algorithm, we set the grid size for the grid
# search algorithm at 3. The original algorithm assumes a grid of size 5.
estimate <- pin_yz(xdata, "LK", grid_size = 3, verbose = FALSE)
# Display the estimated PIN value
show(estimate@pin)
# Display the estimated parameters
show(estimate@parameters)
# Store the initial parameter sets used for MLE in a dataframe variable,
# and display its first five rows
initialsets <- estimate@initialsets
show(head(initialsets, 5))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.