helper_functions: Helper functions in tidystats

In tidystats: Save Output of Statistical Tests

Helper functions in tidystats

Description

Functions used under the hood in the tidystats package.

Usage

tidy_matrix(m, symmetric = TRUE)

add_statistic(
  list,
  name,
  value,
  symbol = NULL,
  subscript = NULL,
  interval = NULL,
  level = NULL,
  lower = NULL,
  upper = NULL
)

symbol(
  x = c("alpha", "chi_squared", "delta", "guttmans_lambda", "K_squared", "lambda",
    "p_hat", "R_squared", "sigma", "t_squared", "tau")
)

expect_equal_models(model, expected_tidy_model, tolerance = 0.001)

write_test_stats(x, path, digits = 6)

Arguments

m

A matrix.

Functions

• tidy_matrix(): Function to convert matrix objects to a tidy data frame.

• add_statistic(): Function to add a statistic to list. It helps create the list and ignores NULL values.

• symbol(): Function to return symbols in ASCII.

• expect_equal_models(): Function to compare tidied models during testing.

• write_test_stats(): Function to save tidied statistics to a file. Since these files are used during testing, it's important to only store files with correctly tidied statistics, hence the prompt.

tidystats documentation built on Oct. 17, 2023, 1:06 a.m.