INFO-201: Foundational Skills For Data Science (Winter 2022)
P01: Project Proposal: Project Proposal Title - Edit Me!
| Project Directories | Brief Description |
|---|---|
/data |
All project datasets should be stored and documented here. For example, if you work with Common Separated Value (.cvs) datasets, they would stored here and documented in this directory's README.md file. Similarly, if you get data from web APIs, you would document the APIs in the directory's README.md. |
/docs |
All project reports and web documents will be published from this directory. This includes Markdown files (.md), R Markdown files (.Rmd), HTML files (.html), and so on. The ./docs directory is the root directory of the website for your project. It will also be used to store all of your design work and project documentation. |
/instructions |
This directory contains the project design brief. |
/source |
All for your R source code will be located in this directory. To organize your code, you might also decide to create sub-directories. |
| .gitignore | This file is important. It tells git to ignore all files that are listed therein. Ignoring "non-useful" files will make it much easier to work togther in your team. See Freeman and Ross (2019, section 3.6) for details. |
| LICENSE | This is a straigtforward software license that basically says "You own the copyright of your code. Others can use your code, so long as they cite that they are doing so." You should put your names into the LICENSE file. If you would like to use a different license, that would be fine! |
- You will use this repository for developing your Final Project. At first, some parts of this initial project set-up will likely be confusing. Please don't worry. During weeks 5-8, you will learning everything you need to know during lectures and labs.
- You will add to this basic directory structure over the course of your project.
- Your first project deliverable, P01: Project Proposal, should be written in Markdown and stored in the file:
./docs/p01-proposal.md - If you need to, you may add additional directories, README.md files, and other files.