feomike / slope

makes a bunch of data objects for time series line charts
1 stars 0 forks source link

develop file naming convention #4

Closed feomike closed 8 years ago

feomike commented 8 years ago

develop file naming convention for the data that drives the thing

feomike commented 8 years ago

the first version naming convention is contained in slide #5 of this shee - https://docs.google.com/presentation/d/1s2X361T4sLzPPG_-Gy9eKjHHIs9X-XHmYNSogy9IShg/edit?usp=sharing.

the naming convention should be: -<code(n)>.json: where:

  • Rssd of entity or ALL (RSSD represents an identity number for a financial institution as developed by the National Information Center (NIC) of the federal reserve board.
  • What code
  • Where code
  • Metric

Example 123456789-1-06-1.json

feomike commented 8 years ago

since the initial concept of the file naming convention, we had a preconceived notion of making the UI RESTful. we decided then that the file name should always be data.json, and in the web root director with a set of sub-directories that would be something like: / where is the rssd (or rid) of the financial institution and is <single_family_originations | denials | sales | refinances>. at a later stage we would think about how to develop sub-directories for . too much to think about today.

feomike commented 8 years ago

calling this done for now.