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

Feature/issue 163 naming consistency #177

Merged
merged 16 commits into from
Mar 26, 2024

Conversation

venpopov
Copy link
Owner

@venpopov venpopov commented Mar 25, 2024

Summary

This PR changes the easier things from #163:

  • fit_model() -> bmm()
    • deprecated but can still use fit_model() with a warning message
  • dIMM and friends -> dimm
    • hard deprecation
  • setsize argument -> set_size
    • deprecated but still usable with a warning
  • OberauerLin_2017 -> oberauer_lin_2017
  • ZhangLuck_2008 -> zhang_luck_2008
  • resp_err -> resp_error
  • deprecate parallel option
    • still usable with a warning, but should just use cores = N where N is the number of chains to run in parallel, just like in brms
  • bmmmodel class -> bmmodel

Since restructuring the models to use a version argument would require a bigger change and testing, I decided to make this into a separate PR.

Tests

[X] Confirm that all tests passed
[X] Confirm that devtools::check() produces no errors

Release notes

Copy link
Collaborator

@GidonFrischkorn GidonFrischkorn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Phew... this was tracking a lot of find & replace details. I tested the changes and added warnings you implemented on my local testing codes and everything ran as expected. This has reduced inconsistencies throughout the package a lot, but it is likely we will still find some every now and then.

@venpopov venpopov merged commit 4dc0457 into develop Mar 26, 2024
3 checks passed
@venpopov venpopov deleted the feature/issue-163-naming-consistency branch March 26, 2024 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants