-
Notifications
You must be signed in to change notification settings - Fork 0
Deliverables and Rubric #4
Description
Deliverables
The primary objective of this individual assignment is to complete the basic steps of creating of a Dash python app.
The ability to communicate findings effectively and present data in a visually compelling way is a crucial skill in many industries, and creating a Dash App can be an excellent way to showcase these skills to potential employers.
Step 1 - Set up the assignment structure
- Set-up a public repository with a reasonable name for your project in your github.com account.
Step 2 - Motivation and purpose
The target audience, persona and research question of this project should be the same one of your milestone project.
- Add in the README the link to your milestone proposal.md file of your milestone describing the project.
Step 3 - Description of your app
For this assignment, we are expecting a simpler app than the one you are creating in the milestones. Therefore, we will not require a detailed sketch from you. However, we encourage you to create a sketch for yourself. Creating a sketch can be a helpful tool in visualizing your app’s layout and functionality, and can save you time in the long run by reducing the number of iterations needed to fine-tune your design. Instead of that, what we will request you is to include an usage section to guide your app users.
- Add in the README an usage section explaining briefly how the users can interact with the app and which information is provided on it.
Step 4. Select the results you want to include in the dashboard in relation to your target audience.
From the dataset you have selected for the milestone, select variables or information that you would like to include in your Dash app.
Step 5. Choose how to present the information in the UI.
Decide what do you want to present in the dashboard (a table, a plot, an interactive plot, an image, text, etc). There should be at least two different reactive elements in your user interface. For example, you can add a plot and a table.
Try to think outside the box, and not reuse exactly the same plots, maps and tables from the milestone you are working on in your Shiny app.
Then, select which widgets will you use to allow the user to interact with your visualizations.
Step 6: Code the app following a workflow.
The app should contain at least:
-
A title.
-
Add a theme using the library dash_bootstrap_components.
-
Two reactive elements with their widgets.
-
Labels or subtitles to all the widgets.
-
If you have included plots or tables, make sure the axis are labeled properly ( don’t use the name of the dataset variable if not a label that anyone can understand), and the units are correct.
-
Check that the reactive elements are working properly (the element is reactive to the user selection) before submitting your app.
-
Include at least two layout (html.* or dbc.*) elements in the UI.
Step 7: mini - peer review activity
Compare your Dash python dashboard with your milestone team members. If you completed this work in individually, your dashboard must be different from your other group team members.
- Write a short text explaining at least two pieces of constructive feedback and add it as a github issue in their repository.
Step 8: Prodution-grade app: ensure the reproducibility and deploy the app.
-
Add a LICENSE.
-
Deploy the app using Render and include the link on the GitHub repo where the user can find it easily (README.md or about section).
-
Add in the README.md a reference section to the dataset you use.
Step 9: Creating the app as an open source project.
-
Add a CONTRIBUTING.md file.
-
Add a CODE_OF_CONDUCT.md file.
Submission
- Submit to “Individual Assignment” on Canvas:
- 1 - the Render link to the deployed Dash python app.
- 2 - the link to GitHub repository of your Dash app.
- 3 - the links to the GitHub issues that you opened for your team members peer review.