R Shiny Dashboard Project Instructions

Information and rubric

For those interested in creating an R/Shiny Dashboard App for your course project, here are what the deliverables should be.

• GitHub Repository (3/25) - As with other course projects, your code should be managed using a GitHub repository. This repository should include multiple commits, each tagged with an informative message. Your workspace should be organized with documentation and data properly named and logically located.
• Organization/Documentation (3.5/25) - Your workspace should include proper metadata files for each raw datasets. It should include a README file summarizing the project, identifying the investigators, including useful searchable keywords, briefly list the datasets used, and any useful information on the workspace structure. (See the template provided on the course website). Additionally, you may want to include additional background material to your work that is relevant but not suitable to include on the dashboard itself. Include a brief summary of major findings and a post mortem of your effort (i.e., where you had issues or might take this project if you had more time)/
• Wrangling Code (3.5/25) - You are encouraged to include Rmd files of any wrangling steps you did to prepare data for the dashboard. This is particularly important if significant time was spend wrangling the data.
• Dashboard Code (5/25) - Your app.R code (or whatever code you used to construct your dashboard) should be well organized and make adequate use of comments any viewer with knowledge of R to follow its logic and structure.
• The Dashboard Structure (5/25) - Your dashboard itself should include enough documentation so that the user can easily use it and understand what it is communicating. It should include a title and the authors’ names. It should also include links to the GitHub repository as well as to any other documentation relevant to the dashboard (e.g. a knit PDF of your wrangling code).
• Dashboard Visualizations & Interactivity (5/25) - The visualizations should be clear and communicate the data effectively. Your selection of widgets should make sense given the control desired. Interactivity among dashboard elements should be logical and robust. The overall dashboard should enable the user to glean more information from the data than by static plots of the data.

What to submit?

Create a Word or PDF document that includes a title, the authors, a brief summary paragraph (this can be the same as what is elsewhere in your documentation) and a link to your GitHub repository. If you were able to publish your dashboard (e.g. to https://shiny.io), include that link as well. An example document is provided here.

Submit this document to Sakai. (Only one team member needs to submit.)