Return at least one effect size measure for htest and BFBayesFactor objects

[IndrajeetPatil]

Given that most users will stick to the defaults most of the time, they might not even realize that we support this functionality, which would be a shame. It'd be nice if we return at least one effect size by default. The default can be whatever effectsize::effectsize() defaults to.

This is especially relevant for objects that don't have estimates in their tidied data frames:

suppressPackageStartupMessages({
  library(parameters)
  library(BayesFactor)
})
data("raceDolls")

m <- contingencyTableBF(
  raceDolls,
  sampleType = "indepMulti",
  fixedMargin = "cols"
)

parameters(m)
#> Warning: Could not estimate a good default ROPE range. Using 'c(-0.1, 0.1)'.
#> Bayesian contingency table analysis
#> 
#> Parameter |                            Prior |   BF
#> ---------------------------------------------------
#> Ratio     | Independent multinomial (0 +- 1) | 1.81
#> 
#> Uncertainty intervals (equal-tailed) and p-values (two-tailed) computed
#>   using a MCMC distribution approximation.

parameters(m, effectsize_type = "cramers_v")
#> Warning: Could not estimate a good default ROPE range. Using 'c(-0.1, 0.1)'.
#> Bayesian contingency table analysis
#> 
#> Parameter | Cramer's V (adj.) | Cramers 95% CI |                            Prior |   BF
#> ----------------------------------------------------------------------------------------
#> Ratio     |              0.15 |   [0.00, 0.29] | Independent multinomial (0 +- 1) | 1.81
#> 
#> Uncertainty intervals (equal-tailed) and p-values (two-tailed) computed
#>   using a MCMC distribution approximation.

^{Created on 2022-10-15 with reprex v2.0.2}

[strengejacke]

Can you take care of this? I think it's just setting a reasonable default for the different effectsizes (like model_parameters for aov, BFBayesFactor etc.)

[mattansb]

If you pass type = NULL to effectsize () it will return a default effect size - so you can just always pass that argument as is!

[strengejacke]

It's indeed a bit more difficult to provide an explicit value. We have model_parameters.htest(), but different default effect sizes. Maybe it's indeed better to just pass NULL by default, but this requires some larger code revisions than just changing an argument value.

[strengejacke]

I think the tricky stuff will be to find out the effectsize-type when this argument is NULL, because this is required:

parameters/R/methods_htest.R

Lines 626 to 638 in 51adc1c

	prefix <- switch(effectsize_type,
	"cohens_g" = "Cohens_",
	"cramers_v" = "Cramers_",
	"phi" = "phi_",
	"cohens_d" = "d_",
	"hedges_g" = "g_",
	"rank_biserial" = "rank_biserial_",
	"rank_epsilon_squared" = "rank_epsilon_squared_",
	"kendalls_w" = "W_",
	"omega" = "Omega2_",
	"eta" = "Eta2_",
	"epsilon" = "Epsilon2_"
	)

[DominiqueMakowski]

I would use "default" in parameters instead of NULL (which should be to not return anything)

[strengejacke]

Yeah, but this still doesn't solve the problem how to detect which effect size was computed (#802 (comment))... :-(

[mattansb]

I think the tricky stuff will be to find out the effectsize-type when this argument is NULL, because this is required:

Why do you need that code? What are you trying do do that isn't covered by effectsize::is_effectsize_name() or effectsize::get_effectsize_name()?

[strengejacke]

So this works on the column names of the returned data frame from effectsize()? I think the returned effect size names differ from those values in the mentioned switch() statement, I need to check whether this breaks any code, maybe in conjunction with format_table().