Code storage

From NorthShore Analytics
Jump to: navigation, search

The following is a suggested directory structure for storing project code:

  • Methodology
    • methodology documents and white papers describing the algorithm;
    • testing and implementation procedures;
    • production implementation requirements;
  • Data
    • input data organized by run date, functionality or model version as appropriate;
    • tools (e.g., Excel spreadsheets) for pre-processing input data (if applicable);
  • Code
    • project files (if applicable);
    • source code differentiated by language (if applicable):
      • R
      • Python
      • SQL
      • C#
      • Other;
  • Log
    • log and error files (if applicable);
  • Results
    • output data files by run date, functionality or model version as appropriate;
    • graphical output by run date, functionality or model version as appropriate;