Data-Science-Projects-Template ReadMe

Project Name

Project Status: [Active, On-Hold, Completed]

Project Intro/Objective

The purpose of this project is ________. (Describe the main goals of the project and potential civic impact. Limit to a short paragraph, 3-6 Sentences)

Partner

[Name of Partner organization/Government department etc..]
Website for partner
Partner contact: [Name of Contact], [slack handle of contact if any]
If you do not have a partner leave this section out

Methods Used

Inferential Statistics
Machine Learning
Data Visualization
Predictive Modeling
etc.

Technologies

R
Python
D3
PostGres, MySql
Pandas, jupyter
HTML
JavaScript
etc.

Project Description

(Provide more detailed overview of the project. Talk a bit about your data sources and what questions and hypothesis you are exploring. What specific data analysis/visualization and modelling work are you using to solve the problem? What blockers and challenges are you facing? Feel free to number or bullet point things here)

Needs of this project

frontend developers
data exploration/descriptive statistics
data processing/cleaning
statistical modeling
writeup/reporting
etc. (be as specific as possible)

Getting Started

Clone this repo (for help see this tutorial).
Raw Data is being kept [here](Repo folder containing raw data) within this repo.

If using offline data mention that and how they may obtain the data from the froup)
Data processing/transformation scripts are being kept [here](Repo folder containing data processing scripts/notebooks)
etc...

If your project is well underway and setup is fairly complicated (ie. requires installation of many packages) create another "setup.md" file and link to it here

Follow setup [instructions](Link to file)

Featured Notebooks/Analysis/Deliverables

Results and Outcomes

Should include interesting outcomes or visualizations. For example, in a dashboarding project.

Acknowledgements and Attributions

Team Leads (Contacts) : [Full Name](https://github.com/[github handle])(@slackHandle)

Other Members:

Name	Slack Handle
[Full Name](https://github.com/[github handle])	@johnDoe
[Full Name](https://github.com/[github handle])	@janeDoe

Contact

If you haven't joined the SF Brigade Slack, you can do that here.
Our slack channel is #datasci-projectname
Feel free to contact team leads with any questions or if you are interested in contributing!

okothchristopher/Data-Science-Projects-Resources