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

Do not use echo = FALSE or warning = FALSE chunk options #98

Open
Bisaloo opened this issue Jul 29, 2024 · 0 comments
Open

Do not use echo = FALSE or warning = FALSE chunk options #98

Bisaloo opened this issue Jul 29, 2024 · 0 comments

Comments

@Bisaloo
Copy link
Member

Bisaloo commented Jul 29, 2024

Using echo = FALSE or warning = FALSE in tutorials means that the output online may not match what the learners are seeing on their screen when running the code.

This is a likely source of confusion and probably not a great practice IMO. If there is a warning somewhere, I would follow these steps in order of priority:

  • try to reformat the code to avoid the warning, especially if it is alerting of a legitimate issue
  • use the warning as a learning opportunity and explain to learners where it comes from and what it means

Additionally, if some packages are too verbose, there may be value to report the issue upstream and see if it should and can be changed there.

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

No branches or pull requests

1 participant