Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add data_dictionary and tests #521

Merged
merged 23 commits into from
Feb 10, 2025
Merged

add data_dictionary and tests #521

merged 23 commits into from
Feb 10, 2025

Conversation

cjyetman
Copy link
Member

@cjyetman cjyetman commented Feb 5, 2025

@cjyetman
Copy link
Member Author

cjyetman commented Feb 6, 2025

@jacobvjk @jdhoffa I'm gonna need help filling out these descriptions. I've searched for definitions and can't find one for many of these columns, and many of them seem like they need to be rather precise

@jdhoffa
Copy link
Member

jdhoffa commented Feb 6, 2025

@cjyetman can you make a list of each dataset column name that you need defined?
and @jacobvjk can you give it a shot to define them?

After that, if you still need my input, let me know.

@cjyetman
Copy link
Member Author

cjyetman commented Feb 6, 2025

@cjyetman can you make a list of each dataset column name that you need defined? and @jacobvjk can you give it a shot to define them?

summarize_weighted_percent_change_output,weighted_percent_change,double,

summarize_weighted_production_output,weighted_production,double,
summarize_weighted_production_output,weighted_technology_share,double,

target_market_share_output,metric,character,

target_market_share_output,technology_share,double,
target_market_share_output,scope,character,
target_market_share_output,percentage_of_initial_production_by_scope,double,

target_sda_output,emission_factor_metric,character,
target_sda_output,emission_factor_value,double,

@jacobvjk
Copy link
Member

jacobvjk commented Feb 6, 2025

@cjyetman these are the descriptions I used in the data dictionary of pacta.multi.loanbook. for the less frequently used exported functions, I will need to check.

summarize_weighted_percent_change_output,weighted_percent_change,double,

  • will need to check

summarize_weighted_production_output,weighted_production,double,
summarize_weighted_production_output,weighted_technology_share,double,

  • weighted_production: "The production of each counterparty in a given technology and year weighted by the portfolio weights of the corresponding loans, summed up by technology for the entire loan book"

target_market_share_output,metric,character,

  • metric: "Indicates if the production related values refer to the projected activities of the underlying counterparty, to the economy wide benchmark, or to allocated levels of activity based on the scenarios"

target_market_share_output,technology_share,double,
target_market_share_output,scope,character,
target_market_share_output,percentage_of_initial_production_by_scope,double,

  • technology_share: "The share of the 'production' the given 'technology' relative to all technologies of the corresponding 'sector' for the gien combination of 'group_id', 'region', 'year' and 'metric'"
  • scope: "Indicates if the targets for the given technology have been calculated based on the TMSR (technology) or the SMSP (sector). High-carbon technologies that need to decrease have their targets calculated on the technology level, whereas low-carbon technologies that need to increase have them calculated on the sector level"
  • percentage_of_initial_production_by_scope: "Relative change compared to the start value (by scope). Used for displaying the change in activity over time on a common scale"

target_sda_output,emission_factor_metric,character,
target_sda_output,emission_factor_value,double,

  • emission_factor_metric: "Indicates if the emission intensity related values refer to the projected activities of the underlying counterparty, to the economy wide benchmark, or to allocated levels of activity based on the scenarios"
  • emission_factor_value: "The physical emission intensity level of the given 'emission_factor_metric'"

@jdhoffa
Copy link
Member

jdhoffa commented Feb 6, 2025

summarize_weighted_percent_change_output,weighted_percent_change,double,

  • the weighted average of the percent change in production associated with a loan, weighted by loan size

summarize_weighted_production_output,weighted_production,double,
summarize_weighted_production_output,weighted_technology_share,double,

  • the weighted sum of the production associated with a loan, weighted by loan size

@cjyetman
Copy link
Member Author

cjyetman commented Feb 6, 2025

one definition left:

summarize_weighted_production_output,weighted_technology_share,double,

@cjyetman
Copy link
Member Author

cjyetman commented Feb 7, 2025

one definition left:

summarize_weighted_production_output,weighted_technology_share,double,

@jdhoffa could this be?

the weighted share of the production from the technology within its sector associated with a loan, weighted by loan size

@jdhoffa
Copy link
Member

jdhoffa commented Feb 10, 2025

one definition left:

summarize_weighted_production_output,weighted_technology_share,double,

@jdhoffa could this be?

the weighted share of the production from the technology within its sector associated with a loan, weighted by loan size

That sounds great!

@cjyetman cjyetman marked this pull request as ready for review February 10, 2025 09:57
@cjyetman cjyetman requested a review from jacobvjk as a code owner February 10, 2025 09:57
@cjyetman cjyetman merged commit 81735cd into main Feb 10, 2025
30 checks passed
@cjyetman cjyetman deleted the add-data_dictionary branch February 10, 2025 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: add data_dictionary
3 participants