COLLABORATOR PROJECT_NAME Project

Maintainer: YOUR_NAME
Collaborators: NAME1, NAME2, ...

This repository contains code for COLLABORATOR's PROJECT_NAME project. The project is PROJECT_DESCRIPTION. The goal of our collaboration is PROJECT_GOAL.

Links:

• Google Drive

File and Directory Structure

Important

Do not commit large files (> 1 MB) to the repository. Upload these to cloud storage (such as Google Drive or Box) instead.

When you clone this repository, Git will not necessarily create directories that only contain large, untracked files (typically data/ and outputs/). Instead you must manually create these directories and download their files from cloud storage.

The directory structure for the project is:

data/           Data sets
docs/           Supporting documents
models/         Trained and serialized models
notebooks/      Notebooks (`.ipynb`, `.Rmd`, ...)
outputs/        Outputs from the code, including intermediate data sets
reports/        HTML or PDF reports generated from notebooks
└── figures/    Graphics and figures to be used in reporting
src/            Python/Java/... (non-R) source code
R/              R source code
.gitattributes  Paths Git should give special treatment
.gitignore      Paths Git should ignore
LICENSE         License for the project
README.md       This file

(back to top)

Installation

(back to top)

Contributing

(back to top)