public
/
cookiecutter-data-science
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README tweaks

This commit is contained in:
Peter Bull 2016-04-23 15:59:58 -04:00
parent ad96dfc6f1
commit 3f1ecb200c
1 changed files with 3 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,8 +1,9 @@
cookiecutter-data-science
Cookiecutter Data Science
-------------------------
An opinionated, but not-afraid-to-be-wrong project template for data science projects. Pull requests welcome. Debate encouraged.
An opinionated, but not-afraid-to-be-wrong project template for data science projects.
### [Project homepage](https://github.com/drivendata/cookiecutter-data-science)
Requirements to create project:
-----------
@ -17,9 +18,3 @@ To start a new project:
[![asciicast](https://asciinema.org/a/9bgl5qh17wlop4xyxu9n9wr02.png)](https://asciinema.org/a/9bgl5qh17wlop4xyxu9n9wr02)
Data
----------
** By default, the `data` folder is included in the `.gitignore` file.** If you have a small amount of data that rarely changes, you may want to include the data in the repository. Github currently warns if files are over 50MB and rejects files over 100MB. Some other options for storing large data include [AWS S3](https://aws.amazon.com/s3/) with a syncing tool (e.g., [`s3cmd`](http://s3tools.org/s3cmd)), [Git Large File Storage](https://git-lfs.github.com/), [Git Annex](https://git-annex.branchable.com/), and [dat](http://dat-data.com/).
The prefered workflow if data is not in the repository is to have a make command `make data` that will download or create the relevant datasets.