Skip to content

Module UI standardization

Nathan Hall edited this page Mar 21, 2023 · 4 revisions

Backgrounds of modules

  • Use of boxes as background
  • Pills for tab navigation

Help sections

  • Help sections should explain what terms mean - e.g. what do you mean by the column "risk window start"
  • ideally every tab should be explained somewhere with sufficient technical detail
  • Plots should have fully descriptive figures

Tables

  • Use of reactable desired
  • Limit the size of tables (e.g. 10 per page - let user configure for more)
  • Slow loading tables - try to think of ways to limit number of rows the user downloads (e.g. required filters)
  • filtering should be enabled on large tables - think "could a user miss a crucial effect estimate or result with this design"
  • Alternating row colours
  • Number of decimal places for floats - 3sf?
  • Add hover over explanations

Icons

  • Font-awesome free icons and classic - we're not going to pay for icons

What not to display

  • Names are important - ids less so
  • Remove row numbers in almost all instances

Colouring

Plots

Avoid use of ggigraph Plotly plots are good but test it don't just use the auto conversion from ggplotly it often breaks.

Exporting data

  • TODO - visit in detail about how to export sections and download results to be used outside of the shiny interface
  • Every plot should be downloadable, every table should be exportable to csv - make the process of generating papers and reports as streamlined as possible

Rmarkdown reports

Objective: Every page view should be exportable to a report (imagine a super long document with 1000 appendices)