epiverse-trace / epiverse-trace/tutorials-early

Do not use `echo = FALSE` or `warning = FALSE` chunk options

Open
#98 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
R
Stars
5
Forks
7
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.