| Author: | Dan Gisolfi |
|---|---|
| Description: | A collection of of research templates for navigating the workflow activities for various types of data analysis projects. |
| Repo Name: | dawn |
| License: | New BSD, See License file. |
The analysis of data is a process of inspecting, cleaning, transforming, and modeling data where the objective may be to discover useful information, suggest conclusions, and/or support decision making. Data analysis has multiple facts and approaches, encompassing diverse techniques under a variety of names, in different business, science, statistical and social science domains.
Researchers in these domains tend to organize their work differently and produce dissimilar artifacts. Yet each domain researcher is challenged with a very basic and important metric, time-to-value:
- How much time is required to go from problem definition to actionable insights?
- How much time is required to develop and package reproducible research?
- How much time is required to synthesize research into a written artifact (report, proposal, etc)?
Provide a collection of general purpose or domain specific workflow templates that will help navigate a data analysis project. These templates are meant to serve as guides for the project. The guides are provided based on experience to help others organize data analysis projects and the artifacts (insights, plots, code, etc) of the endeavor.
The benefits of the guides are:
- Analytical consistency
- Research organization and navigation
- Reduced time-to-value
The guides included in dawn are language and platform neutral. The intent here is to focus on the workflow tasks and observations for a data analysis project. While a guide may be derived from an R markdown file, for example, the content of the guide should be reusable in a variety of interactive analytical tools such as iClojure, iPython, and iScala, and RStudio.
The following workflow navigation templates are included:
- Reproducible Analysis Navigation Template (rant)
- Rapid Business Insights (rbi)
- Systems Development Life Cycle (sdlc)
Each guide package contains:
- README.rst - A Restructured Text file describing purpose of the guide
- <name>_guide.<ext> - One or more guide template file, where <name> is the name of the guide and <ext> is the type of file (.txt, .md, .ipynb, etc)
Additionally, guide packages may also incude:
- Sample use cases
The use and distribution terms for this software are covered by the "New BSD" license which can be found in the file LICENSE at the root of this distribution. By using this software in any fashion, you are agreeing to be bound by the terms of this license. You must not remove this notice, or any other, from this software.
- Clone the latest master branch from GitHub
- Open your favorite interactive analysis tool
- Open the <guide_name>_guide.md file
- Begin your data analysis activity
Contributors, if in agreement with the License terms, are encouraged to fork the code and send GitHub pull requests.
As a designated trail in the woods, these guides mark a path once taken. There is no harm in deviating from an existing guide or in the establishment of a new one. If a guide is only needed to get you get started, then the guide has served it's purpose.
"An investigator starts research in a new field with faith, a foggy idea, and a few wild experiments. Eventually the interplay of negative and positive results guides the work. By the time the research is completed, he or she knows how it should have been started and conducted." - Donald Cram, American Chemist and 1987 Nobel Prize Winner.