discussion: dataset rules/end user API

[epogrebnyak]

Please let me know what part of writing is not clear yet and ask your questions (English or Russian):
Пожалуйста напишите какая часть описания вызывает вопросы:

https://github.com/mini-kep/intro/blob/master/pipeline/older_versions/datamodel_and_api.md

This will help me streamline discussion based on your questions, which whould be a good way to go. Many thanks!

[epogrebnyak]

As introduction , @zarak (Zarak) worked with me on original parser-rosstat-kep, we are tackling parser standartisation with @kkravchuk (Konstantin) and @relique (Aldi) takes care for front-end app.

[epogrebnyak]

Trying to formalise the API workflow:

1. From enduser API call we are getting the args for database query

args_api_call = dict(
   # variable 
   # mandatory part
   domain = "ru",
   varname = "BRENT"
   frequency = "m"   

   # optional part
   rate = None
   agg = "eop"

   #time limits
   start = "2015"
   end = "2016"   

   # output format finaliser (can skip now)
   finaliser = None
)

2. The variable is identified by mandatory part (domain, varname, frequency) and optional part (real growth rate + aggregator).

• Prices are usually daily (eg BRENT, USDRUR, interest rates), to aggregate to monthly and up we use eop or avg aggregator. Should be a rule Can I apply aggregation to this variable?

• Mandatory part always points to nominal variables or to current prices, but not to real growth rates

• rate points to real growth rate variables

[epogrebnyak]

Probably should move this to wiki?