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

Best practices to control output verbosity #603

Closed
mpadge opened this issue Jan 31, 2023 · 0 comments · Fixed by #765
Closed

Best practices to control output verbosity #603

mpadge opened this issue Jan 31, 2023 · 0 comments · Fixed by #765
Assignees

Comments

@mpadge
Copy link
Member

mpadge commented Jan 31, 2023

A private rOpenSci slack discussion originally prompted by frictionlessdata/frictionless-r#120 and instigated by @peterdesmet let to @jennybc pointing us to tidyverse/design#42. The latter issue in particular raises some important points regarding general design for control of package-level verbosity.

Why is this important?

Because of current package-ecosystem-level options like tidyverse.quiet and component packages such as readr which now rely on package-level options to control verbosity. Any packages which ultimately, and not necessarily even directly, call potentially verbose tidyverse functions will generate output determined by such options.

Current practice

I'm pretty confident that running pkgstats over all rOpenSci packages - definitely including mine 😉 - would reveal a predominance of function-level control of verbosity through single parameters. Moreover, I'd be equally confident that the majority of such parameters would be logical, and so would not allow any finer-level control over verbosity.

Suggestions

Given the clear direction of discussion in tidyverse/design#42, we can likely assume progression away from function-level control of verbosity towards package-level control, along with more fine-grained options other than simple logical variables. I would argue that this alone suggests a clear need for some kind of "best practices" on control of verbosity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant