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/117 add a message upon loading the package #137

Merged
merged 7 commits into from
Feb 27, 2024

Conversation

GidonFrischkorn
Copy link
Collaborator

Summary

  • add a package startup message.
  • by convention this is added in the zzz.R file

I just thought that I share my implementation and then you can have a look at what is there and add things if there are settings that you think we should set .onLoad

Tests

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

Release notes

@GidonFrischkorn GidonFrischkorn added documentation Improvements or additions to documentation PR - patch Pull request should update patch version labels Feb 27, 2024
@GidonFrischkorn GidonFrischkorn added this to the 1.0.0 milestone Feb 27, 2024
@GidonFrischkorn GidonFrischkorn self-assigned this Feb 27, 2024
@GidonFrischkorn GidonFrischkorn linked an issue Feb 27, 2024 that may be closed by this pull request
@venpopov
Copy link
Owner

perfect, will checkout now

- bmm_options() allows to view or set all bmm global options
- it is called onLoad to set defaults and display them in the package load message
- add tryCatch2 to be able to handle messages and display them when desired
Copy link
Owner

@venpopov venpopov left a comment

Choose a reason for hiding this comment

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

Looks good. I added a new commit:

  • new function bmm_options and use it onLoad
  • bmm_options() allows to view or set all bmm global options
  • it is called onLoad to set defaults and display them in the package load message
  • add tryCatch2 to be able to handle messages and display them when desired
  • version bump and news entry

When you load the package now it looks like this:

image

@venpopov venpopov merged commit e3c53df into develop Feb 27, 2024
3 checks passed
@venpopov venpopov deleted the feature/117-add-a-message-upon-loading-the-package branch February 27, 2024 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation PR - patch Pull request should update patch version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add a message upon loading the package
2 participants