Expand documentation for the use and reproducibility of side effects functions in qenv #1181

Job	Run time
R CMD Check (non-CRAN) 🧬 / ghcr.io/insightsengineering/rstudio, version latest	24s
SuperLinter 🦸‍♀️ / Lint R code 🧶	25s
Roxygen 🅾 / Manual pages check 🏁	24s
SuperLinter 🦸‍♀️ / SuperLinter 🦸‍♂️	24s
Coverage 📔 / Covtracer 🐄	4s
Version Check 🏁 / Version check 🏁	4s
R CMD Check 🧬 / ghcr.io/insightsengineering/rstudio, version latest	26s
Coverage 📔 / Coverage 📔	23s
Style Check 👗 / Check code style 🔠	25s
Spell Check 🆎 / Check spelling 🔠	24s
Version Check 🏁 / Emoji in NEWS.md 📰	10s
gitleaks 💧 / gitleaks 💧	7s
License Check 🃏 / Check 🚩	28s
Grammar Check 🔤 / Check 📝	18s
Check URLs 🌐 / URL Checker 🔎	28s
Audit Dependencies 🕵️‍♂️ / oysteR scan 🦪	1m 37s
Version Bump 🤜🤛	0s
gitleaks 💧 / PII Check 💳	0s
Check URLs 🌐 / Validate Links 🔎	0s
R CMD Check (non-CRAN) 🧬 / Publish JUnit HTML report 📰	1s
R CMD Check (non-CRAN) 🧬 / Upload build tar.gz	1s
Coverage 📔 / Publish coverage report 📰	1s
R CMD Check 🧬 / Upload build tar.gz	1s
R CMD Check 🧬 / Publish JUnit HTML report 📰	1s
	6m 36s

Provide feedback