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

Use versions to indicate changes to data year w/ documented update schedule #3

Open
elipousson opened this issue Sep 22, 2022 · 2 comments
Labels
data documentation Improvements or additions to documentation enhancement New feature or request

Comments

@elipousson
Copy link
Owner

If this package is ever going to be useful to other folks than myself, I need better documentation for changes to the underlying data. I just updated the MTA Bus stop and bus route data but, in the process realized that I missed the 2021 data release (no longer available online although I can likely request it) and I also have no place to indicate the current year for any of the datasets beyond the title.

There is a similar issue with my bcpss package so I need to investigate the best approach to implement in both cases.

@elipousson elipousson added documentation Improvements or additions to documentation enhancement New feature or request data labels Sep 22, 2022
@elipousson
Copy link
Owner Author

The versioning approach outlined in the Natural Earth Vector repository seems like it may be a helpful model to use the overall package versioning to track changes to the underlying data: https://github.com/nvkelso/natural-earth-vector#versioning

@elipousson
Copy link
Owner Author

If mapbaltimore is also using data from related packages like bcpss, I could do detailed tracking of changes on the source packages and link to those from mapbaltimore. It wouldn't work in all cases so I'd need to document how I handled version tracking for different datasets.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant