TestStatistic | R Documentation |
This is the abstract base class for test statistic objects like CondKolmY or MEP.
Test statistics are built around the key method
calc_stat()
which calculates the particular test statistic (and
x-y-values that can be used to plot the underlying process).
get_value()
Returns the value of the test statistic.
TestStatistic$get_value()
value of the test statistic
calc_stat()
Calculate the value of the test statistic for given data and a model to test for.
TestStatistic$calc_stat(data, model)
data
list()
containing the data
model
ParamRegrModel to test for
The modified object (self
), allowing for method chaining.
get_plot_xy()
Returns vectors of x and y that can be used to plot the process corresponding to the test statistic.
TestStatistic$get_plot_xy()
list with plot.x and plot.y being vectors of the same length
print()
Overrides the print-method for objects of type
TestStatistic
to only print its value.
TestStatistic$print()
The object (self
), allowing for method chaining.
geom_ts_proc()
Creates a line plot showing the underlying process of the test statistic.
TestStatistic$geom_ts_proc(...)
...
Other arguments passed on to ggplot2::geom_line()
. These are
often aesthetics, used to set an aesthetic to a fixed value, like
colour = "red"
or size = 3
.
A ggplot2 layer representing a line plot.
plot()
Creates a new ggplot showing the underlying process of the test statistic.
TestStatistic$plot(...)
...
Other arguments passed on to ggplot2::geom_line()
. These are
often aesthetics, used to set an aesthetic to a fixed value, like
colour = "red"
or size = 3
.
A ggplot2 object representing the complete plot, including a line geometry.
clone()
The objects of this class are cloneable with this method.
TestStatistic$clone(deep = FALSE)
deep
Whether to make a deep clone.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.