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

include help with installing bbi in error message if not found #636

Open
andersone1 opened this issue Jan 11, 2024 · 2 comments
Open

include help with installing bbi in error message if not found #636

andersone1 opened this issue Jan 11, 2024 · 2 comments

Comments

@andersone1
Copy link

Current behavior when a bbr function is run on a system without bbi installed:

Error in compare_bbi_version(.bbi_exe_path, .min_version, fail = FALSE) :
`/data/home/username/project.mrg/bi/qc-jan/bin/bbi` was not found on the system.

Can we append how to install bbi to this error message (and be more specific about where it is being looked for), making it something like:

Error in compare_bbi_version(.bbi_exe_path, .min_version, fail = FALSE) 
`/data/home/username/project.mrg/bi/qc-jan/bin/bbi` was not found at path {getOption('bbr.bbi_exe_path')}.
either run `bbr::use_bbi()` to install bbi or\n,
check what you entered in the `bbr.bbi_exe_path` option and make sure it is correct.
@seth127
Copy link
Collaborator

seth127 commented Jan 11, 2024

I like this idea @andersone1 . @barrettk has also been messing around with some nicer formatting for error messages (#624 for example). Notably, this can call attention to things that the user should act on right away, as opposed to more verbose output that is more helpful for debugging.

@seth127
Copy link
Collaborator

seth127 commented Jan 18, 2024

A few notes after reviewing this with @barrettk

  • We have almost the same error message in two places (here and here). Let's define that in one place and pass it in both places.
  • In terms of the error message, let's make sure to include:
    • bbi was not found at {getOption('bbr.bbi_exe_path')}
    • Either run bbr::use_bbi() to install bbi or ...
    • assign a path to a working version of bbi to options('bbr.bbi_exe_path' = '/path/to/bbi')
  • Try to make the formatting as readable as possible, because this is a lot for some users to process

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

No branches or pull requests

2 participants