Project 0: Introduction
Walkthrough
Background
We will complete six projects during the semester that each take about two weeks (four days of class). On average, a student will spend 2 hours outside of class per hour in class to complete the assigned readings, submit any Canvas items, and complete the project (for a total of 8 hours per project). The instruction for each project will be structured into sections as written on this page.
This first Background section provides context for the project. Make sure you read the background carefully to see the big picture needs and purpose of the project.
Python and VS Code are tools commonly used in the field of data science. During our first two days of class we will get VS Code prepped for data science programming. Completing Project 0 will set you up for success the rest of the semester.
Data
Every data science project should start with data, and our class projects are no different. Each project will have ‘Download’ and ‘Information’ links like the ones below.
URL: penguins data
= load_penguins()
penguins penguins
Readings
The Readings section will contain links to reading assignments that are required for each project, as well as optional references. Remember that you are reading this material to build skills. Take the time to comprehend the readings and the skills contained within.
We recommend reading through the assigned material once for a general understanding before the first day of each project. You will reread and reference the material multiple times as you complete the project.
The readings listed below are required for the first two days of class.
- Course Setup (Do)
- Learn about our Book Python for Data Science (Skim)
- PY4DS: First Steps (Skim)
- PY4DS: CH1 Whole Game (Skim)
- PY4DS: CH2 Data Visualization (Read)
- P4DS: CH30 Markdown (Read)
- P4DS: CH31 Quarto (Skim)
- Quarto Instructional Template for DS (Read)
Optional References
Questions and Tasks
This section lists the questions and tasks that need to be completed for the project. Your work on the project must be compiled into a report, pushed to GitHub and a URL submitted in Canvas by the weekend following the last day of material for the project.
In the DS 250 folder of the Course Work Portfolio, edit the Project0.qmd
quarto file to build a report that includes the following:
- The
project_0.qmd
file is has working code for the Penguine data set. You need to finish the project by updating its markdown so that it is a report by completing the following tasks:- do not modify or remove any of the code cells while completing the tasks, the code is already there for you
- remove the introduction header and text
- update the elevator pitch per its instructions
- copy and paste this question for Question|Task 1
- Recreate the example charts from PY4DS: CH2 Data Visualization of the textbook.
- copy and paste this question for Question|Task 2
- Include the tables created from PY4DS: CH2 Data Visualization used to create the above chart
- Include the tables created from PY4DS: CH2 Data Visualization used to create the above chart
- remove the notes at the bottom of the file
- follow the instructions in the submission section below to submit your work
- Update the
resume.qmd
file in course work portfolio to include your updated resume using markdown. See P4DS: CH30 Markdown
Submission:
When you have completed the report, you will need to follow this process to submit your work:
- Have the Course Work Portfolio open in VS Code and open
Projects/Project0.qmd
- Click
Preview Button
in VS Code in the top right of the screen- This will render the project but also entire course work portfolio into
HTML
files for review - Confirm everything displas as you would like it to
- How you see it will be how it is viewed for grading
- If there is an error in any cell of the quarto files, the rendering will stop and you will need to fix the error before rendering again (if you get stuck post your error in Slack)
- This will render the project but also entire course work portfolio into
- Once the report is confirmed close the preview and open the
GitHub Desktop
application - Type a summary of the changes in the
Summary
box - Click
Commit to main
blue button in the bottom left corner - Click
Push origin
blue button in the middle right of the screen- This will push all your changes in the project .qmd file to GitHub
- The publish.yml file will kick off an automated process to render the project into HTML files
- The HTML files will be published to GitHub pages in the gh-pages branch
- The URL to the published project will be in the deployment section in GitHub
- In
GitHub Desktop
clickOpen in GitHub
to navigete to the repository - Click on the
Actions
tab and make sure there were no errors in the rendering process - Click on the
deployment
section of the main page of the repository to find the URL - Navigate to the URL and confirm it displays as you intended
- Copy the URL and submit it in Canvas
- In
Deliverables:
Deliverables are “the quantifiable goods or services that must be provided upon the completion of a project”. In this class the deliverable for each project is a GitHub published report created using Quarto files. This final section will be the same for each project.
Use this template to submit your Client Report. The template has two sections:
- A short elevator pitch that highlights key values or metrics from the results. Describing these key insights to interest or hook the reader to want to read more about your work. The writing style should be more technical with some creative elements. Do not summarize what you did.
- Answers to the questions | tasks. Each should include a written description of your results, code cells with comments, charts and/or tables.
- A short summary of work must be submitted in the comments in Canvas wwhen you submit the URL. Rate your own work on a scale of 1-5. 1 being poor and 5 being excellent. Include a short description of why you rated your work the way you did.
Your report should be written in quarto markdown files and pushed to GitHub. Submit a URL of the rendered project in Canvas. (Do not submit the URL to the GitHub .qmd
file)
Feedback:
You will recieve feedback and/or coaching notes in the form of a GitHub issue. You will need to address the feedback, re-render and resubmit the project, and mark the GitHub issue as closed.
Resubmission:
You will have one opportunity to resubmit the project after you have received feedback. The window for the resubmission will be open through the Wednesday following the due date of the project. Therefore it is recomended that you turn in a draft of the project early on the Thursday before the due date to ensure you have time to address any feedback and resubmit the project. It is acceptable to turn in a draft that is only 80% complete. This will allow you to get feedback on the majority of the project and then focus on the final details. The closer to that Thursday you turn in the draft the more feedback and coaching you will recieve.