repo_template

This section should contain an overview of your repository. For example, this is a general-purpose template repository for all projects in Ma Lab.

Get Started

To use this template for your own project, select the green button titled "Use this Template". By default, the owner should be "NYUMaLab". Give your repository a descriptive name, separated by underscores instead of spaces e.g. my_project_name. Click here for a guide on how to use Github Repo Templates

Directory

Every repository should have a directory for files describing the structure of the repository and a high-level overview of the contents

repo_template
│   README.md 
│
└─── analysis : all analysis files
│   │
│   └───demos : runnable demonstration scripts
│   │
│   └───figures
│   │
│   └───processed_data
│   │
│   └───src : analysis code goes here
│
│   
└─── experiment : all experiment files
│   │
│   └───raw_data : unmodified data -- DO NOT EDIT
│   │
│   └───src : experiment code goes here
│
└─── resources : tutorials, presentations, papers, posters, etc.

Installation

Instructions for how to install the necessary files

Usage (Experiment)

Instructions for how to run experiments

Usage (Analysis)

Instructions for how to run analysis

Demo(s)

Description of demos

Authors and Acknowledgements

Your name and other collaborators here

License

Contact lab about licensing code