Package 'automatedtests'

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

• AutomatedTest$new()

• AutomatedTest$get_data()

• AutomatedTest$is_paired()

• AutomatedTest$get_identifiers()

• AutomatedTest$get_compare_to()

• AutomatedTest$set_compare_co()

• AutomatedTest$get_datatypes()

• AutomatedTest$get_parametric_list()

• AutomatedTest$is_parametric()

• AutomatedTest$get_test()

• AutomatedTest$get_result()

• AutomatedTest$get_strength()

• AutomatedTest$is_significant()

• AutomatedTest$print()

• AutomatedTest$clone()

Method new()

Initialize an instance of the AutomatedTest class

Usage

AutomatedTest$new(data, identifiers, compare_to = NULL, paired = FALSE)

Arguments

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

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

Description

Automatically choose the best fitting statistical test for your data, and returns an easily readable AutomatedTest object from either a data frame or individual vectors. This object contains the executed test together with all statistics and properties.

Usage

automatical_test(..., compare_to = NULL, identifiers = FALSE, paired = FALSE)

Arguments

Details

The automatical_test function automatically selects and runs the most fitting statistical test based on the data provided. It can accept data as either a single data frame or multiple individual vectors, provided the vectors are of equal length.

If identifiers is set to TRUE, the first column will be treated as identifiers and excluded from the test, supporting TIDY data.

When a multiple group test is selected (i.e., more than two groups, columns, or variables are used), the first non-identifier column will be used as the grouping or target variable, meaning all other variables will be tested against it.

The paired parameter can be used to force paired testing for supported tests (such as McNemar's test or Cochran's Q), even if identifiers are not explicitly included in the input.

If you want to override the defaults, you can change the compare_to value to specify one-sample tests.

Once the test has been executed, you can use the method $get_result() on the resulting object to get more detailed information about the test's execution, including a summary of the test used and all statistics.

Supported tests:

Value

An object of class AutomatedTest. The object contains the results of the statistical test performed on the data. You can use the method $get_result() to obtain more detailed information about the execution of the test.

Author(s)

Wouter Zeevat

See Also

AutomatedTest for the class used by this function.

Examples

# Example 1: Using individual vectors
  test1 <- automatical_test(iris$Species, iris$Sepal.Length, identifiers = FALSE)

  # Example 2: Forcing a paired test
  before <- c(200, 220, 215, 205, 210)
  after <- c(202, 225, 220, 210, 215)
  paired_data <- data.frame(before, after)
  test2 <- automatical_test(before, after, paired = TRUE)

  # Retrieve more detailed information about the test
  # test1$get_result()