Now that the Canada-USA paper is closer to publication, there should probably be an effort to improve a few key areas on the repository documentation since its referenced in the paper. Off the top of my head....
Update README.md documentation on each page (Issue #126)
Review and update the Wiki so there is consistency between the paper and the code (Issue #107, #106, #73, #59)
Update installation and running instructions (which are quite a bit out of date). May be worth it to prioritize issue #80 to add the remaining pieces to the snakemake workflow.
In the config.yaml file, specify what parameters can and can't be changed. For example, changing the spatial groupings in Canada should be fine (probably deserves a test run though), however, we can't currently change USA spatial groupings due to us still using aggregated data on that.
I probably missed one or two sections that also deserve a review, so this list definitively isnt exhaustive. Im just thinking if readers and researchers arrive on the repository, we should make excellent first impressions! :)
Now that the Canada-USA paper is closer to publication, there should probably be an effort to improve a few key areas on the repository documentation since its referenced in the paper. Off the top of my head....
README.mddocumentation on each page (Issue #126)config.yamlfile, specify what parameters can and can't be changed. For example, changing the spatial groupings in Canada should be fine (probably deserves a test run though), however, we can't currently change USA spatial groupings due to us still using aggregated data on that.I probably missed one or two sections that also deserve a review, so this list definitively isnt exhaustive. Im just thinking if readers and researchers arrive on the repository, we should make excellent first impressions! :)