The-Strategy-Unit / The-Strategy-Unit/data_science
Add a style section about Shiny
Open
Nobody has claimed this yet.
section: style guide
- Dominant language
- Jupyter Notebook
- Stars
- 11
- Forks
- 5
- Avg merge
- 5h 34m
- Merged PRs (30d)
- 1
Description
Prompted by a question internal to SU about best practices and how we work with Shiny.
I suspect we'd mention things like:
- modularity
- {bslib}
- testing, e.g. snapshots, mocking, {shinytest2}
- data sourcing/loading
- philosophy of {golem}/{nolem}
- strategies to limit RAM use
- when Shiny isn't the right tool for the job
Add more ideas below.
Related to the suggested Shiny C&C session: #238.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the project's existing style guidance and review the related Shiny C&C discussion in #238. Add a Shiny section covering modularity, {bslib}, testing with snapshots, mocking and {shinytest2}, data sourcing, {golem}/{nolem}, RAM usage, and when Shiny is unsuitable; done means the agreed guidance is documented clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100