special-scripts/grimmer-replace-names.R

In lhdjung/scrutiny: Error Detection in Science

# NOTE: All variables that should be renamed in scrutiny's version of GRIMMER
# need to be entered here!

# -- Variables that can't be replaced targeting whole words only, such as any
# that include dots, need to be entered in `grimmer_names_whole_word_false`.
# -- All other variables need to be entered in `grimmer_names`.


# Load helper functions:
source("special-scripts/replace-in-file.R")

# File where variable names should be replaced:
path_file <- "R/grimmer-rsprite2.R"


# Dots don't count toward words, so the script needs this extra table with names
# that include dots. `replace_from_df()` will then run on it with `whole_word =
# FALSE`. Note the "\\." escape sequence!
grimmer_names_whole_word_false <- tibble::tribble(
  ~rsprite2,             ~scrutiny,
  "\\.sd_limits",        "sd_bounds_measure"
)

replace_from_df(
  path = path_file,
  df_names = grimmer_names_whole_word_false,
  col_pattern = "rsprite2",
  col_replacement = "scrutiny",
  whole_word = FALSE
)


grimmer_names <- tibble::tribble(
  ~rsprite2,             ~scrutiny,
  # --- Function ---
  "GRIMMER_test",        "grimmer_scalar",
  # --- Arguments ---
  # (Note that some arguments from `rsprite2::GRIMMER_test()` are missing in
  # scrutiny's adapted version, and vice versa.)
  "mean",                "x",
  "SD",                  "sd",
  "n_obs",               "n",
  "n_items",             "items",
  # --- Internal variables ---
  "decimals_mean",       "digits_x",
  "decimals_SD",         "digits_sd",
  "realmean",            "x_real",
  "realsum",             "sum_real",
  "sd_limits",           "sd_bounds",
  "effective_n",         "n_items",
  "Lsigma",              "sd_lower",
  "Usigma",              "sd_upper",
  "Lowerbound",          "sum_squares_lower",
  "Upperbound",          "sum_squares_upper",
  "possible_integers",   "integers_possible",
  "Predicted_Variance",  "var_predicted",
  "Predicted_SD",        "sd_predicted",
  "oddness",             "parity",
  "Matches_Oddness",     "matches_parity",
  "FirstTest",           "pass_test1",
  "Rounded_SD_down",     "sd_rounded_down",
  "Rounded_SD_up",       "sd_rounded_up",
  "Matches_SD",          "matches_sd",
  "Third_Test",          "pass_test3",
)

# Replace the rsprite2 variable names by those of scrutiny:
replace_from_df(
  path = path_file,
  df_names = grimmer_names,
  col_pattern = "rsprite2",
  col_replacement = "scrutiny"
)