-

Welcome to Peter

-

For full documentation visit mkdocs.org.

-

Commands

+

Cookiecutter Data Science

+

Why?

+

We often think data analysis is a report, some visualizations and or some insights. While these end products are generated by code, it's easy to focus on making to products look real good and ignore the quality of the code that generates them.

+

On top of that, it's no secret that good analyses are often the result of exploration, experimentation, and digging into the data to see what works. This is not a process that lends itself to thinking carefully about the structure of your code or your project beforehand. So, let someone else do that thinking and the setup for you. Here's why:

+

Other people will thank you

+

A well-defined project structure means that a newcomer can begin to understand an analysis without digging in to extensive documentation. Well organized code is self-documenting and provides a lot of context for your code without much overhead. People will thank you for this because they can:

    -
  • mkdocs new [dir-name] - Create a new project.
    • -
  • mkdocs serve - Start the live-reloading docs server.
    • -
  • mkdocs build - Build the documentation site.
    • -
  • mkdocs help - Print this help message.
    • +
  • Collaborate easily with you on this analysis
    • +
  • Easily learn from your analysis about the process and the domain
    • +
  • Feel confident in the conclusions the analysis presents
-

Project layout

-
mkdocs.yml    # The configuration file.
-docs/
-    index.md  # The documentation homepage.
-    ...       # Other markdown pages, images and other files.
-