The AutomatedTest class represents a result of a statistical test. It contains attributes such as the p-value, degrees of freedom, and more.
new()
Initialize an instance of the AutomatedTest class
AutomatedTest$new(data, identifiers, compare_to = NULL, paired = FALSE)
data
A dataframe containing the data for the test.
identifiers
A vector with the identifiers.
compare_to
Numeric value to compare to for comparison in one-sample tests. Default is NULL.
paired
Logical; if TRUE, the test will be performed as paired if applicable. Default is FALSE.
get_data()
Get the data used in the test
AutomatedTest$get_data()
A dataframe with all features
is_paired()
Shows if the data is paired, if there are multiple rows with the same identifier, the data has more samples (TIDY DATA). Making the data paired.
AutomatedTest$is_paired()
Whether the data is paired (TRUE/FALSE).
get_identifiers()
A list of the identifiers used for the data
AutomatedTest$get_identifiers()
Returns the identifiers
get_compare_to()
Get the comparison value for one-sample tests
AutomatedTest$get_compare_to()
A numeric value for comparison
set_compare_co()
Updates the compare_to variable. Is public because the compare value can get changed depending on the type of test. This function is public because it needs to be able to be called by automatical_test()
AutomatedTest$set_compare_co(compare_to)
compare_to
Numeric value to compare to.
Updated object with comparison value set.
get_datatypes()
Get the data types of the features in the object
AutomatedTest$get_datatypes()
A list of data types (e.g., Quantitative or Qualitative)
get_parametric_list()
Get the parametric test results of the features
AutomatedTest$get_parametric_list()
A list of parametric test results
is_parametric()
Check if the data meets parametric assumptions
AutomatedTest$is_parametric()
TRUE if parametric assumptions are met, otherwise FALSE
get_test()
Get the statistical test that was chosen
AutomatedTest$get_test()
The name of the statistical test
get_result()
Get the result of selected statistical test
AutomatedTest$get_result()
The result of the statistical test
get_strength()
Get the strength(s) of selected statistical test.
AutomatedTest$get_strength()
A named numeric value indicating the strength of the result. The type and meaning depend on the test used:
Effect size and direction of predictors in regression
Correlation strength and direction
Difference in group means
Test statistic measuring group difference or association
Ratio of variances across groups
Estimated success rate in the sample
No interpretable strength measure available
is_significant()
Whether the test results are significant or not.
AutomatedTest$is_significant()
TRUE / FALSE depending on the significance of the test.
clone()
The objects of this class are cloneable with this method.
AutomatedTest$clone(deep = FALSE)
deep
Whether to make a deep clone.