Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NEW: API #391

Merged
merged 43 commits into from
Nov 30, 2021
Merged

NEW: API #391

merged 43 commits into from
Nov 30, 2021

Conversation

mattansb
Copy link
Member

@mattansb mattansb commented Oct 21, 2021

There are 3 major functions that need a reliable API. This is the goal for version 1.0.0

eta_squared()

Essentially any model that can produce one of 3 tables will be supported:

  • Basic (aov)
  • Multi-level (aovlist)
  • Approx (anova-F)

And also:

standardize.default()

standardize_parameters()

And also:

  • parameters_model - it should be possible to get the effect size without having to also call parameters!
    • Have standardize_parameters() use standardize_parameters.parameters_model() for complete usage.

standardize_info()

  • Add more info to the vignette.

@codecov-commenter

This comment has been minimized.

@mattansb mattansb self-assigned this Oct 21, 2021
@mattansb mattansb added this to the CRAN 1.0.0 milestone Oct 21, 2021
@mattansb mattansb mentioned this pull request Oct 21, 2021
8 tasks
@bwiernik
Copy link
Contributor

Should it be eta_squared()?

@mattansb
Copy link
Member Author

hehe yeah

@mattansb
Copy link
Member Author

@strengejacke I am working here on allowing full support for parameters_model objects. This is intended to somewhat "soften" the circular dependency between effectsize and parameters.

When I'm done, ideally, parameters will not have to pass regression / anova models to effectsize, and instead can (and should) pass the processed parameters_model data.frame object (instead of what we currently have - multiple calls to model_parameters, which is what is causing the "hard" circular dependency).

I'll let you know when this is done - then we can think about how to utilize these changes in parameters.

@bwiernik
Copy link
Contributor

What does parameters need from effectsize? Can we eliminate that entirely?

@mattansb
Copy link
Member Author

It gives users an option to append the effect sizes to the parameters' table.

Historically, all the effectsize functions were part of parameters, and at some point they broke off to do their own thing.

Perhaps, in the future, this can be handed off to report::report_table() to do the parameters + effectsize + performance binding.

@bwiernik
Copy link
Contributor

Yeah, that's something that would be better in report I think, same with, eg, getting both raw and exponentiated coefficients in one table.

Is this specifically for ANOVA type contexts?

@mattansb
Copy link
Member Author

For regression models (for standardized slopes), ANOVA tables, and some htest models.

@strengejacke
Copy link
Member

and instead can (and should) pass the processed parameters_model data.frame object

This might be tricky for standardized coefficients. For standardize = "refit", I call effectsize::standardize() before I do all the stuff in model_parameters(). But at least we might reduce the circular dependency.

@mattansb
Copy link
Member Author

mattansb commented Nov 9, 2021

Not only the standardization would neen to be moved to parameters, also the ANOVA effect size functions and the effectsize.htest() (which depends on cohens_d(), rank_biserial(), etc....). So literally everything, except for the interpret functions (which, as we all know, should be in report).

@mattansb
Copy link
Member Author

Post-hoc standardize_parameters() API is getting too big - merging this for now.

@mattansb mattansb merged commit f5dac59 into main Nov 30, 2021
@mattansb mattansb deleted the API branch November 30, 2021 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants