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

Rename NL2019 dataset to NL, NL to NL2015 #3871

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

antw
Copy link
Contributor

@antw antw commented Dec 14, 2021

@marliekeverweij
Copy link
Contributor

@antw I am wondering now why we choose to rename the nl2019 to nl. I think nl2019 is more clear, then you're sure that it's the 2019 dataset.

Sorry for the (very) late input on this PR!!

@antw
Copy link
Contributor Author

antw commented Jan 31, 2022

My feeling was that {country_code} should represent the latest version of our modeling. Otherwise some people – especially those who use the API – are likely to continue using nl to create scenarios, unaware that the dataset they are using is old.

@marliekeverweij
Copy link
Contributor

Thanks for your reply @antw. Do you say that it is better for our API users to keep the nl dataset alive? I would prefer to disable / remove the nl dataset and request API users to use nl2019 instead

@antw
Copy link
Contributor Author

antw commented Feb 1, 2022

Do you say that it is better for our API users to keep the nl dataset alive?

I believe so. For two reasons:

  1. Including the analysis year is not consistent with the rest of our datasets. We have uk not uk2015, fr not fr2012. The change should not be too confusing to API users, since the scenario data includes the start year:

    {
        "id": 12345,
        "area_code": "nl",
        "start_year": 2015,
        "end_year": 2050
    }
  2. Most importantly, API users may have their workflows broken if the nl dataset suddenly disappears.

In the longer term, my preferred approach would be for API users to create a scenario by providing the region name nl and the start year, and if they don't provide a year we'd default to the latest.

{ 
    "area_code": "nl",
    "start_year": 2019
}

@marliekeverweij
Copy link
Contributor

Okay, I understand the reasons! Especially the second.

The first reason doesn't really go for all datasets anymore. Almost all country datasets are now generated through ETLocal and their dataset name is {geo_id}_{country_name}. Most ETDataset-datasets have been removed, except for: the Dutch datasets, dk,deand eu.

@marliekeverweij
Copy link
Contributor

In the longer term, my preferred approach would be for API users to create a scenario by providing the region name nl and the start year, and if they don't provide a year we'd default to the latest.

👍 ✨

@github-actions
Copy link

This pull request has had no activity for 60 days and will be closed in 7 days. Removing the "Stale" label or posting a comment will prevent it from being closed automatically. You can also add the "Pinned" label to ensure it isn't marked as stale in the future.

@github-actions github-actions bot added the Stale Issue had no activity for 60 days and will be, or has been, closed. label May 16, 2022
@mabijkerk mabijkerk removed the Stale Issue had no activity for 60 days and will be, or has been, closed. label May 23, 2022
@AlexanderWirtz
Copy link
Contributor

Just weighing in on this discussion:

For transparency and clarity, I believe it would be good to eventually state the year explicitly in the dataset label. We just found out, for example, that for NSWPH Guidehouse was using 2019 datasets for all countries but de, nl and dk. Of course, they could have paid a little more attention, but as ever more people create scenarios in bulk through the API, the starting year is less explicitly visible.

Anyway, since this will have a huge impact on their scenario outcomes and the 2015 datasets are not as good as the 2019 ones, it might be good to come up with a more explicit solution to avoid thing kind of stuff in the future.

@mabijkerk mabijkerk added the Pinned Will never be marked as stale or auto-closed. label Aug 1, 2022
@kaskranenburgQ
Copy link
Contributor

@mabijkerk Can we close this?
I think a new effort must be made, since there are a lot of conflicts at the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Pinned Will never be marked as stale or auto-closed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants