Skip to content

clarelgibson/dash

Repository files navigation

DASH

Data Analysis Starts Here (DASH)

Purpose

To provide an open-source toolbox that enables data analysts to produce consistent, well-documented data analysis projects. Template scripts are written in R but could be adapted to Python or any other suitable language for data analysis.

Getting started

This template repository contains sample data, documentation and analysis as an example of a data analysis project that follows DASH methodology. You can replace the data and customize the template files and scripts to suit your own project.

Create a new repository from this template

To get started, you should create a new repository from this template for your own data analysis project. You can do this by clicking on Use this template above the file list on the main page of this repository, and then choosing Create a new repository.

Screenshot of a menu button indicating Use this template, with a dropdown to select either Create a new repository or Open in a codespace
The Use this template button on a Github template repository home page. Image: Github

Full guidance on creating a new repository from a Github template can be found here.

Customizing the README

In your new repository, delete README.md. Rename sampleREADME.md to README.md. Customize the new README.md file as required to fit your own project. Don't forget to customize the contact information at the bottom of the new README.md file.

Customizing the documentation

The project documentation folders are numbered 01 to 05. Within each folder are templates that you can customize to support your data analysis, including the project's goals or the business use case, the intended stakeholders, key performance indicators (KPIs), data sources and assumptions, data preparation steps, exploratory data analysis, explanatory analysis, insights and optimizations. Access each folder in turn to customize the documentation to your project.

Acknowledgements

This template is inspired by various online data analysis courses and articles, including:

The icons used in this project were made by the following authors from Flaticon:

Contact

You can use the following channels to get in touch with me about this project:

  • Email me for any questions about the project, or to collaborate with me on making it better.
  • GitHub Issues for direct feedback, enhancement requests or raising bugs.

About

Data Analysis Starts Here (DASH). A toolkit for reproducible data analysis projects in R.

Topics

Resources

License

Stars

Watchers

Forks

Languages