AutomatedTest {automatedtests} | R Documentation |
AutomatedTest class
Description
The AutomatedTest class represents a result of a statistical test. It contains attributes such as the p-value, degrees of freedom, and more.
Methods
Public methods
Method new()
Initialize an instance of the AutomatedTest class
Usage
AutomatedTest$new(data, identifiers, compare_to = NULL, paired = FALSE)
Arguments
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.
Method get_data()
Get the data used in the test
Usage
AutomatedTest$get_data()
Returns
A dataframe with all features
Method 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.
Usage
AutomatedTest$is_paired()
Returns
Whether the data is paired (TRUE/FALSE).
Method get_identifiers()
A list of the identifiers used for the data
Usage
AutomatedTest$get_identifiers()
Returns
Returns the identifiers
Method get_compare_to()
Get the comparison value for one-sample tests
Usage
AutomatedTest$get_compare_to()
Returns
A numeric value for comparison
Method 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()
Usage
AutomatedTest$set_compare_co(compare_to)
Arguments
compare_to
Numeric value to compare to.
Returns
Updated object with comparison value set.
Method get_datatypes()
Get the data types of the features in the object
Usage
AutomatedTest$get_datatypes()
Returns
A list of data types (e.g., Quantitative or Qualitative)
Method get_parametric_list()
Get the parametric test results of the features
Usage
AutomatedTest$get_parametric_list()
Returns
A list of parametric test results
Method is_parametric()
Check if the data meets parametric assumptions
Usage
AutomatedTest$is_parametric()
Returns
TRUE if parametric assumptions are met, otherwise FALSE
Method get_test()
Get the statistical test that was chosen
Usage
AutomatedTest$get_test()
Returns
The name of the statistical test
Method get_result()
Get the result of selected statistical test
Usage
AutomatedTest$get_result()
Returns
The result of the statistical test
Method get_strength()
Get the strength(s) of selected statistical test.
Usage
AutomatedTest$get_strength()
Returns
A named numeric value indicating the strength of the result. The type and meaning depend on the test used:
- coefficient
Effect size and direction of predictors in regression
- r
Correlation strength and direction
- mean difference
Difference in group means
- statistic
Test statistic measuring group difference or association
- F statistic
Ratio of variances across groups
- proportion
Estimated success rate in the sample
- non-existent
No interpretable strength measure available
Method is_significant()
Whether the test results are significant or not.
Usage
AutomatedTest$is_significant()
Returns
TRUE / FALSE depending on the significance of the test.
Method print()
Print a summary of the test object
Usage
AutomatedTest$print()
Method clone()
The objects of this class are cloneable with this method.
Usage
AutomatedTest$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.