justicehub-in / justice-hub-docs

Documentation platform for the Justice Hub

Home Page:https://docs.justicehub.in/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Create a data dictionary format

apoorv74 opened this issue · comments

A standard format to be shared with all data contributors. This is required because most of the data contributors maintain their own formats and some don't maintain any form of data dictionaries. Data moderators, while creating reports from these datasets would want to know specific details around variables, such as :

  • Name
  • Data type (Numeric, Character, etc)
  • Definition (How a variable is defined)
  • Variable Type (Categorical or Continuous)
  • Variable codes (possible values, if data is categorical)
  • Missing values code (How are missing values treated in a dataset)
  • File present in (If a dataset has multiple files)
  • Variable source (Origin, Created by the user)
    • Calculated fields
  • Mathematical formulas used to calculate a field

Check this - https://karthik.github.io/ddd/#minimal

A few guidelines are added on this page. Closing this for now, will pick it up later as per platform requirements.